[
][
C:
/
Program Files (x86)
/
AWS SDK for .NET
/
past-releases
/
Version-2
/
Net35
/]
Upload
Terminal
File Manager
Server Info
Current File :
C:/Program Files (x86)/AWS SDK for .NET/past-releases/Version-2/Net35/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.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.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.CheckIfStatementExists(Amazon.Auth.AccessControlPolicy.Statement)"> <summary> Checks to see if the permissions set in the statement are already set by another statement in the policy. </summary> <param name="statement">The statement to verify</param> <returns>True if the statement's permissions are already allowed by the statement</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.WithStatements(Amazon.Auth.AccessControlPolicy.Statement[])"> <summary> Sets the collection of statements contained by this policy and returns this policy object so that additional method calls can be chained together. <para> Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. </para> </summary> <param name="statements">The collection of statements included in this policy.</param> <returns>this instance</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson"> <summary> Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. </summary> <returns>A JSON string representation of this AWS access control policy.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.ToJson(System.Boolean)"> <summary> Returns a JSON string representation of this AWS access control policy, suitable to be sent to an AWS service as part of a request to set an access control policy. </summary> <param name="prettyPrint">Toggle pretty print for the generated JSON document</param> <returns>A JSON string representation of this AWS access control policy.</returns> </member> <member name="M:Amazon.Auth.AccessControlPolicy.Policy.FromJson(System.String)"> <summary> Parses a JSON document of a policy and creates a Policy object. </summary> <param name="json">JSON document of a policy.</param> <returns></returns> </member> <member name="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 and sets the version of this AWS policy. </summary> </member> <member name="P:Amazon.Auth.AccessControlPolicy.Policy.Statements"> <summary> Gets and Sets the collection of statements contained by this policy. Individual statements in a policy are what specify the rules that enable or disable access to your AWS resources. </summary> </member> <member name="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.AmazonAutoScalingClient"> <summary> Implementation for accessing AutoScaling Auto Scaling <para> Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services. </para> </summary> </member> <member name="M:Amazon.Runtime.AmazonServiceClient.DontUnescapePathDotsAndSlashes(System.Uri)"> <summary> Patches the in-flight uri to stop it unescaping the path etc (what Uri did before Microsoft deprecated the constructor flag). This is particularly important for Amazon S3 customers who want to use backslash (\) in their key names. </summary> <remarks> Different behavior in the various runtimes has been observed and in addition some 'documented' ways of doing this between 2.x and 4.x runtimes has also been observed to not be reliable. This patch effectively emulates what adding a schemesettings element to the app.config file with value 'name="http" genericUriParserOptions="DontUnescapePathDotsAndSlashes"' does. As we're a dll, that avenue is not open to us. </remarks> <param name="uri"></param> </member> <member name="M:Amazon.Runtime.AmazonServiceClient.CloneConfig``1"> <summary> Used to create a copy of the config for a different service than the current instance. </summary> <typeparam name="C"></typeparam> <returns></returns> </member> <member name="E:Amazon.Runtime.AmazonServiceClient.BeforeMarshallingEvent"> <summary> Occurs before a request is marshalled. </summary> </member> <member name="E:Amazon.Runtime.AmazonServiceClient.BeforeRequestEvent"> <summary> Occurs before a request is issued against the service. </summary> </member> <member name="E:Amazon.Runtime.AmazonServiceClient.AfterResponseEvent"> <summary> Occurs after a response is received from the service. </summary> </member> <member name="E:Amazon.Runtime.AmazonServiceClient.ExceptionEvent"> <summary> Occurs after an exception is encountered. </summary> </member> <member name="T:Amazon.AutoScaling.IAmazonAutoScaling"> <summary> Interface for accessing AutoScaling Auto Scaling <para> Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services. </para> </summary> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.AttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest)"> <summary> Attaches one or more EC2 instances to the specified Auto Scaling group. <para> When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances service method.</param> <returns>The response from the AttachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginAttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. </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.IAmazonAutoScaling.EndAttachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachInstances operation. </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.IAmazonAutoScaling.AttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest)"> <summary> Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers service method.</param> <returns>The response from the AttachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginAttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers 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 EndAttachLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EndAttachLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachLoadBalancers.</param> <returns>Returns a AttachLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> Completes the lifecycle action for the specified token or instance with the specified result. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li><b>If you finish before the timeout period ends, complete the lifecycle action.</b></li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction service method.</param> <returns>The response from the CompleteLifecycleAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginCompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. </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.IAmazonAutoScaling.EndCompleteLifecycleAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CompleteLifecycleAction operation. </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.IAmazonAutoScaling.CreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest)"> <summary> Creates an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup service method.</param> <returns>The response from the CreateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginCreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. </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.IAmazonAutoScaling.EndCreateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAutoScalingGroup operation. </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.IAmazonAutoScaling.CreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest)"> <summary> Creates a launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration service method.</param> <returns>The response from the CreateLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginCreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. </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.IAmazonAutoScaling.EndCreateLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLaunchConfiguration operation. </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.IAmazonAutoScaling.CreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest)"> <summary> Creates or updates tags for the specified Auto Scaling group. <para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags service method.</param> <returns>The response from the CreateOrUpdateTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginCreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. </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.IAmazonAutoScaling.EndCreateOrUpdateTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateOrUpdateTags operation. </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.IAmazonAutoScaling.DeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest)"> <summary> Deletes the specified Auto Scaling group. <para> If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. </para> <para> If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. </para> <para> To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances. </para> <para> To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup service method.</param> <returns>The response from the DeleteAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. </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.IAmazonAutoScaling.EndDeleteAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAutoScalingGroup operation. </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.IAmazonAutoScaling.DeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest)"> <summary> Deletes the specified launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration service method.</param> <returns>The response from the DeleteLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. </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.IAmazonAutoScaling.EndDeleteLaunchConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLaunchConfiguration operation. </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.IAmazonAutoScaling.DeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest)"> <summary> Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook service method.</param> <returns>The response from the DeleteLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. </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.IAmazonAutoScaling.EndDeleteLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLifecycleHook operation. </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.IAmazonAutoScaling.DeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest)"> <summary> Deletes the specified notification. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration service method.</param> <returns>The response from the DeleteNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. </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.IAmazonAutoScaling.EndDeleteNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNotificationConfiguration operation. </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.IAmazonAutoScaling.DeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest)"> <summary> Deletes the specified Auto Scaling policy. <para> Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </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.IAmazonAutoScaling.EndDeletePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePolicy operation. </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.IAmazonAutoScaling.DeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest)"> <summary> Deletes the specified scheduled action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction service method.</param> <returns>The response from the DeleteScheduledAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. </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.IAmazonAutoScaling.EndDeleteScheduledAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteScheduledAction operation. </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.IAmazonAutoScaling.DeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest)"> <summary> Deletes the specified tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </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.IAmazonAutoScaling.EndDeleteTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTags operation. </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.IAmazonAutoScaling.DescribeAccountLimits"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </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.IAmazonAutoScaling.EndDescribeAccountLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountLimits operation. </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.IAmazonAutoScaling.DescribeAdjustmentTypes"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes service method.</param> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. </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.IAmazonAutoScaling.EndDescribeAdjustmentTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAdjustmentTypes operation. </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.IAmazonAutoScaling.DescribeAutoScalingGroups"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups service method.</param> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. </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.IAmazonAutoScaling.EndDescribeAutoScalingGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingGroups operation. </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.IAmazonAutoScaling.DescribeAutoScalingInstances"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances service method.</param> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. </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.IAmazonAutoScaling.EndDescribeAutoScalingInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingInstances operation. </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.IAmazonAutoScaling.DescribeAutoScalingNotificationTypes"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.</param> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. </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.IAmazonAutoScaling.EndDescribeAutoScalingNotificationTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. </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.IAmazonAutoScaling.DescribeLaunchConfigurations"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations service method.</param> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. </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.IAmazonAutoScaling.EndDescribeLaunchConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLaunchConfigurations operation. </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.IAmazonAutoScaling.DescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest)"> <summary> Describes the lifecycle hooks for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks service method.</param> <returns>The response from the DescribeLifecycleHooks service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. </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.IAmazonAutoScaling.EndDescribeLifecycleHooks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHooks operation. </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.IAmazonAutoScaling.DescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest)"> <summary> Describes the available types of lifecycle hooks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.</param> <returns>The response from the DescribeLifecycleHookTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. </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.IAmazonAutoScaling.EndDescribeLifecycleHookTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLifecycleHookTypes operation. </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.IAmazonAutoScaling.DescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest)"> <summary> Describes the load balancers for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers 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 EndDescribeLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EndDescribeLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancers.</param> <returns>Returns a DescribeLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeMetricCollectionTypes"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.</param> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. </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.IAmazonAutoScaling.EndDescribeMetricCollectionTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMetricCollectionTypes operation. </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.IAmazonAutoScaling.DescribeNotificationConfigurations"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations service method.</param> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. </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.IAmazonAutoScaling.EndDescribeNotificationConfigurations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNotificationConfigurations operation. </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.IAmazonAutoScaling.DescribePolicies"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies service method.</param> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. </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.IAmazonAutoScaling.EndDescribePolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePolicies operation. </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.IAmazonAutoScaling.DescribeScalingActivities"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities service method.</param> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. </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.IAmazonAutoScaling.EndDescribeScalingActivities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingActivities operation. </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.IAmazonAutoScaling.DescribeScalingProcessTypes"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes service method.</param> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. </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.IAmazonAutoScaling.EndDescribeScalingProcessTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingProcessTypes operation. </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.IAmazonAutoScaling.DescribeScheduledActions"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions service method.</param> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. </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.IAmazonAutoScaling.EndDescribeScheduledActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScheduledActions operation. </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.IAmazonAutoScaling.DescribeTags"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </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.IAmazonAutoScaling.EndDescribeTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTags operation. </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.IAmazonAutoScaling.DescribeTerminationPolicyTypes"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.</param> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. </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.IAmazonAutoScaling.EndDescribeTerminationPolicyTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTerminationPolicyTypes operation. </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.IAmazonAutoScaling.DetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest)"> <summary> Removes one or more instances from the specified Auto Scaling group. <para> After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. </para> <para> If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances service method.</param> <returns>The response from the DetachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. </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.IAmazonAutoScaling.EndDetachInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachInstances operation. </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.IAmazonAutoScaling.DetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest)"> <summary> Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers service method.</param> <returns>The response from the DetachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers 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 EndDetachLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EndDetachLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachLoadBalancers.</param> <returns>Returns a DetachLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection service method.</param> <returns>The response from the DisableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginDisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. </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.IAmazonAutoScaling.EndDisableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableMetricsCollection operation. </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.IAmazonAutoScaling.EnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest)"> <summary> Enables monitoring of the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection service method.</param> <returns>The response from the EnableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginEnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. </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.IAmazonAutoScaling.EndEnableMetricsCollection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableMetricsCollection operation. </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.IAmazonAutoScaling.EnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest)"> <summary> Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby service method.</param> <returns>The response from the EnterStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginEnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. </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.IAmazonAutoScaling.EndEnterStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnterStandby operation. </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.IAmazonAutoScaling.ExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest)"> <summary> Executes the specified policy. </summary> <param name="request">Container for the necessary parameters to execute the ExecutePolicy service method.</param> <returns>The response from the ExecutePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. </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.IAmazonAutoScaling.EndExecutePolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecutePolicy operation. </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.IAmazonAutoScaling.ExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest)"> <summary> Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby service method.</param> <returns>The response from the ExitStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. </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.IAmazonAutoScaling.EndExitStandby(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExitStandby operation. </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.IAmazonAutoScaling.PutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest)"> <summary> Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para> <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li><b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b></li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook service method.</param> <returns>The response from the PutLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginPutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. </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.IAmazonAutoScaling.EndPutLifecycleHook(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutLifecycleHook operation. </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.IAmazonAutoScaling.PutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest)"> <summary> Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address. <para> For more information see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASGettingNotifications.html">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> This configuration overwrites an existing configuration. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration service method.</param> <returns>The response from the PutNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginPutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. </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.IAmazonAutoScaling.EndPutNotificationConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutNotificationConfiguration operation. </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.IAmazonAutoScaling.PutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest)"> <summary> Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy service method.</param> <returns>The response from the PutScalingPolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginPutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. </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.IAmazonAutoScaling.EndPutScalingPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScalingPolicy operation. </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.IAmazonAutoScaling.PutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest)"> <summary> Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.</param> <returns>The response from the PutScheduledUpdateGroupAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginPutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. </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.IAmazonAutoScaling.EndPutScheduledUpdateGroupAction(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutScheduledUpdateGroupAction operation. </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.IAmazonAutoScaling.RecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest)"> <summary> Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li><b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.</param> <returns>The response from the RecordLifecycleActionHeartbeat service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginRecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. </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.IAmazonAutoScaling.EndRecordLifecycleActionHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RecordLifecycleActionHeartbeat operation. </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.IAmazonAutoScaling.ResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest)"> <summary> Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses service method.</param> <returns>The response from the ResumeProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. </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.IAmazonAutoScaling.EndResumeProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResumeProcesses operation. </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.IAmazonAutoScaling.SetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest)"> <summary> Sets the size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity service method.</param> <returns>The response from the SetDesiredCapacity service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginSetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. </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.IAmazonAutoScaling.EndSetDesiredCapacity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetDesiredCapacity operation. </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.IAmazonAutoScaling.SetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest)"> <summary> Sets the health status of the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth service method.</param> <returns>The response from the SetInstanceHealth service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginSetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. </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.IAmazonAutoScaling.EndSetInstanceHealth(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetInstanceHealth operation. </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.IAmazonAutoScaling.SetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest)"> <summary> Updates the instance protection settings of the specified instances. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection service method.</param> <returns>The response from the SetInstanceProtection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginSetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection 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 EndSetInstanceProtection operation.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.EndSetInstanceProtection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetInstanceProtection.</param> <returns>Returns a SetInstanceProtectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses service method.</param> <returns>The response from the SuspendProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginSuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. </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.IAmazonAutoScaling.EndSuspendProcesses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SuspendProcesses operation. </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.IAmazonAutoScaling.TerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest)"> <summary> Terminates the specified instance and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.</param> <returns>The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginTerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. </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.IAmazonAutoScaling.EndTerminateInstanceInAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. </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.IAmazonAutoScaling.UpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest)"> <summary> Updates the configuration for the specified Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para> <para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para> <para> Note the following: </para> <ul> <li> <para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para> </li> <li> <para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para> </li> <li> <para> All other optional parameters are left unchanged if not specified. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup service method.</param> <returns>The response from the UpdateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.IAmazonAutoScaling.BeginUpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. </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.IAmazonAutoScaling.EndUpdateAutoScalingGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAutoScalingGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAutoScalingGroup.</param> <returns>Returns a UpdateAutoScalingGroupResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Credentials and an AmazonAutoScalingClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.#ctor(System.String,System.String,System.String,Amazon.AutoScaling.AmazonAutoScalingConfig)"> <summary> Constructs AmazonAutoScalingClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonAutoScalingClient Configuration Object</param> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.AttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest)"> <summary> Attaches one or more EC2 instances to the specified Auto Scaling group. <para> When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachInstances service method.</param> <returns>The response from the AttachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginAttachInstances(Amazon.AutoScaling.Model.AttachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInstances operation. </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. </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.AttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest)"> <summary> Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers service method.</param> <returns>The response from the AttachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginAttachLoadBalancers(Amazon.AutoScaling.Model.AttachLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachLoadBalancers 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 EndAttachLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndAttachLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachLoadBalancers.</param> <returns>Returns a AttachLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.CompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest)"> <summary> Completes the lifecycle action for the specified token or instance with the specified result. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li><b>If you finish before the timeout period ends, complete the lifecycle action.</b></li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CompleteLifecycleAction service method.</param> <returns>The response from the CompleteLifecycleAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCompleteLifecycleAction(Amazon.AutoScaling.Model.CompleteLifecycleActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CompleteLifecycleAction operation. </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. </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 an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateAutoScalingGroup service method.</param> <returns>The response from the CreateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateAutoScalingGroup(Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAutoScalingGroup operation. </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. </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 launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLaunchConfiguration service method.</param> <returns>The response from the CreateLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateLaunchConfiguration(Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLaunchConfiguration operation. </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. </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 or updates tags for the specified Auto Scaling group. <para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateOrUpdateTags service method.</param> <returns>The response from the CreateOrUpdateTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginCreateOrUpdateTags(Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateOrUpdateTags operation. </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. </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. <para> If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. </para> <para> If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. </para> <para> To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances. </para> <para> To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteAutoScalingGroup service method.</param> <returns>The response from the DeleteAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteAutoScalingGroup(Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAutoScalingGroup operation. </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. </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 launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLaunchConfiguration service method.</param> <returns>The response from the DeleteLaunchConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteLaunchConfiguration(Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLaunchConfiguration operation. </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. </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> Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteLifecycleHook service method.</param> <returns>The response from the DeleteLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteLifecycleHook(Amazon.AutoScaling.Model.DeleteLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLifecycleHook operation. </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. </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 the specified notification. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNotificationConfiguration service method.</param> <returns>The response from the DeleteNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteNotificationConfiguration(Amazon.AutoScaling.Model.DeleteNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNotificationConfiguration operation. </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. </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 the specified Auto Scaling policy. <para> Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePolicy service method.</param> <returns>The response from the DeletePolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeletePolicy(Amazon.AutoScaling.Model.DeletePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePolicy operation. </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. </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 the specified scheduled action. </summary> <param name="request">Container for the necessary parameters to execute the DeleteScheduledAction service method.</param> <returns>The response from the DeleteScheduledAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteScheduledAction(Amazon.AutoScaling.Model.DeleteScheduledActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteScheduledAction operation. </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. </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> Deletes the specified tags. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDeleteTags(Amazon.AutoScaling.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </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. </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> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest)"> <summary> Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAccountLimits(Amazon.AutoScaling.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </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. </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> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest)"> <summary> Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAdjustmentTypes service method.</param> <returns>The response from the DescribeAdjustmentTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAdjustmentTypes(Amazon.AutoScaling.Model.DescribeAdjustmentTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAdjustmentTypes operation. </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. </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> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest)"> <summary> Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingGroups service method.</param> <returns>The response from the DescribeAutoScalingGroups service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingGroups(Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingGroups operation. </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. </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> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest)"> <summary> Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingInstances service method.</param> <returns>The response from the DescribeAutoScalingInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingInstances(Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingInstances operation. </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. </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> Describes the notification types that are supported by Auto Scaling. </summary> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest)"> <summary> Describes the notification types that are supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.</param> <returns>The response from the DescribeAutoScalingNotificationTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeAutoScalingNotificationTypes(Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAutoScalingNotificationTypes operation. </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. </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> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest)"> <summary> Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLaunchConfigurations service method.</param> <returns>The response from the DescribeLaunchConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLaunchConfigurations(Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLaunchConfigurations operation. </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. </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> Describes the lifecycle hooks for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHooks service method.</param> <returns>The response from the DescribeLifecycleHooks service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLifecycleHooks(Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHooks operation. </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. </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> Describes the available types of lifecycle hooks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.</param> <returns>The response from the DescribeLifecycleHookTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLifecycleHookTypes(Amazon.AutoScaling.Model.DescribeLifecycleHookTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLifecycleHookTypes operation. </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. </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.DescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest)"> <summary> Describes the load balancers for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers service method.</param> <returns>The response from the DescribeLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeLoadBalancers(Amazon.AutoScaling.Model.DescribeLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLoadBalancers 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 EndDescribeLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDescribeLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLoadBalancers.</param> <returns>Returns a DescribeLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest)"> <summary> Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.</param> <returns>The response from the DescribeMetricCollectionTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeMetricCollectionTypes(Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricCollectionTypes operation. </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. </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> Describes the notification actions associated with the specified Auto Scaling group. </summary> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest)"> <summary> Describes the notification actions associated with the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNotificationConfigurations service method.</param> <returns>The response from the DescribeNotificationConfigurations service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeNotificationConfigurations(Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNotificationConfigurations operation. </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. </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> Describes the policies for the specified Auto Scaling group. </summary> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest)"> <summary> Describes the policies for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DescribePolicies service method.</param> <returns>The response from the DescribePolicies service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribePolicies(Amazon.AutoScaling.Model.DescribePoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePolicies operation. </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. </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> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest)"> <summary> Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingActivities service method.</param> <returns>The response from the DescribeScalingActivities service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScalingActivities(Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingActivities operation. </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. </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> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest)"> <summary> Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingProcessTypes service method.</param> <returns>The response from the DescribeScalingProcessTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScalingProcessTypes(Amazon.AutoScaling.Model.DescribeScalingProcessTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingProcessTypes operation. </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. </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> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest)"> <summary> Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScheduledActions service method.</param> <returns>The response from the DescribeScheduledActions service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeScheduledActions(Amazon.AutoScaling.Model.DescribeScheduledActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScheduledActions operation. </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. </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> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest)"> <summary> Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.InvalidNextTokenException"> The <code>NextToken</code> value is not valid. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeTags(Amazon.AutoScaling.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </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. </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> Describes the termination policies supported by Auto Scaling. </summary> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest)"> <summary> Describes the termination policies supported by Auto Scaling. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.</param> <returns>The response from the DescribeTerminationPolicyTypes service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDescribeTerminationPolicyTypes(Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTerminationPolicyTypes operation. </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. </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> Removes one or more instances from the specified Auto Scaling group. <para> After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. </para> <para> If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachInstances service method.</param> <returns>The response from the DetachInstances service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDetachInstances(Amazon.AutoScaling.Model.DetachInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInstances operation. </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. </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.DetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest)"> <summary> Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers service method.</param> <returns>The response from the DetachLoadBalancers service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDetachLoadBalancers(Amazon.AutoScaling.Model.DetachLoadBalancersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachLoadBalancers 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 EndDetachLoadBalancers operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndDetachLoadBalancers(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachLoadBalancers operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachLoadBalancers.</param> <returns>Returns a DetachLoadBalancersResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.DisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest)"> <summary> Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> <param name="request">Container for the necessary parameters to execute the DisableMetricsCollection service method.</param> <returns>The response from the DisableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginDisableMetricsCollection(Amazon.AutoScaling.Model.DisableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableMetricsCollection operation. </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. </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 the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnableMetricsCollection service method.</param> <returns>The response from the EnableMetricsCollection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginEnableMetricsCollection(Amazon.AutoScaling.Model.EnableMetricsCollectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableMetricsCollection operation. </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. </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> Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the EnterStandby service method.</param> <returns>The response from the EnterStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginEnterStandby(Amazon.AutoScaling.Model.EnterStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnterStandby operation. </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. </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.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginExecutePolicy(Amazon.AutoScaling.Model.ExecutePolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecutePolicy operation. </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. </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> Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ExitStandby service method.</param> <returns>The response from the ExitStandby service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginExitStandby(Amazon.AutoScaling.Model.ExitStandbyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExitStandby operation. </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. </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> Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para> <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li><b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b></li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLifecycleHook service method.</param> <returns>The response from the PutLifecycleHook service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutLifecycleHook(Amazon.AutoScaling.Model.PutLifecycleHookRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLifecycleHook operation. </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. </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">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> This configuration overwrites an existing configuration. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutNotificationConfiguration service method.</param> <returns>The response from the PutNotificationConfiguration service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutNotificationConfiguration(Amazon.AutoScaling.Model.PutNotificationConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutNotificationConfiguration operation. </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. </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 parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScalingPolicy service method.</param> <returns>The response from the PutScalingPolicy service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutScalingPolicy(Amazon.AutoScaling.Model.PutScalingPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScalingPolicy operation. </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. </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 more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.</param> <returns>The response from the PutScheduledUpdateGroupAction service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.AlreadyExistsException"> You already have an Auto Scaling group or launch configuration with this name. </exception> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginPutScheduledUpdateGroupAction(Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutScheduledUpdateGroupAction operation. </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. </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> Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li><b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.</param> <returns>The response from the RecordLifecycleActionHeartbeat service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginRecordLifecycleActionHeartbeat(Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RecordLifecycleActionHeartbeat operation. </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. </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 the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResumeProcesses service method.</param> <returns>The response from the ResumeProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginResumeProcesses(Amazon.AutoScaling.Model.ResumeProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResumeProcesses operation. </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. </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 size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetDesiredCapacity service method.</param> <returns>The response from the SetDesiredCapacity service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSetDesiredCapacity(Amazon.AutoScaling.Model.SetDesiredCapacityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetDesiredCapacity operation. </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. </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 the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceHealth service method.</param> <returns>The response from the SetInstanceHealth service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSetInstanceHealth(Amazon.AutoScaling.Model.SetInstanceHealthRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceHealth operation. </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. </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.SetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest)"> <summary> Updates the instance protection settings of the specified instances. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection service method.</param> <returns>The response from the SetInstanceProtection service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.LimitExceededException"> You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see <a>DescribeAccountLimits</a>. </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSetInstanceProtection(Amazon.AutoScaling.Model.SetInstanceProtectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="request">Container for the necessary parameters to execute the SetInstanceProtection 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 EndSetInstanceProtection operation.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.EndSetInstanceProtection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetInstanceProtection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetInstanceProtection.</param> <returns>Returns a SetInstanceProtectionResult from AutoScaling.</returns> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.SuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest)"> <summary> Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the SuspendProcesses service method.</param> <returns>The response from the SuspendProcesses service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ResourceInUseException"> The Auto Scaling group or launch configuration can't be deleted because it is in use. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginSuspendProcesses(Amazon.AutoScaling.Model.SuspendProcessesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SuspendProcesses operation. </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. </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 and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.</param> <returns>The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginTerminateInstanceInAutoScalingGroup(Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstanceInAutoScalingGroup operation. </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. </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 Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para> <para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para> <para> Note the following: </para> <ul> <li> <para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para> </li> <li> <para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para> </li> <li> <para> All other optional parameters are left unchanged if not specified. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateAutoScalingGroup service method.</param> <returns>The response from the UpdateAutoScalingGroup service method, as returned by AutoScaling.</returns> <exception cref="T:Amazon.AutoScaling.Model.ResourceContentionException"> You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer). </exception> <exception cref="T:Amazon.AutoScaling.Model.ScalingActivityInProgressException"> The Auto Scaling group can't be deleted because there are scaling activities in progress. </exception> </member> <member name="M:Amazon.AutoScaling.AmazonAutoScalingClient.BeginUpdateAutoScalingGroup(Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAutoScalingGroup operation. </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. </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> <summary> This class is the base class of all the configurations settings to connect to a service. </summary> </member> <member name="M:Amazon.Runtime.ClientConfig.Validate"> <summary> Performs validation on this config object. Throws exception if any of the required values are missing/invalid. </summary> </member> <member name="M:Amazon.Runtime.ClientConfig.GetTimeoutValue(System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})"> <summary> Returns the request timeout value if its value is set, else returns client timeout value. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyHost"> <summary> Gets and sets of the ProxyHost property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyPort"> <summary> Gets and sets of the ProxyPort property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.MaxIdleTime"> <summary> Gets and sets the max idle time set on the ServicePoint for the WebRequest. Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, in which case ServicePointManager.MaxServicePointIdleTime will be used as the default. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ConnectionLimit"> <summary> Gets and sets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UseNagleAlgorithm"> <summary> Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite default than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ReadWriteTimeout"> <summary> Overrides the default read-write timeout value. </summary> <remarks> <para> If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used to send requests. </para> <exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception> </remarks> <seealso cref="P:System.Net.HttpWebRequest.ReadWriteTimeout"/> <seealso cref="P:System.Net.Http.WebRequestHandler.ReadWriteTimeout"/> </member> <member name="P:Amazon.Runtime.ClientConfig.ServiceVersion"> <summary> Gets Service Version </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.SignatureMethod"> <summary> Gets and sets of the signatureMethod property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.SignatureVersion"> <summary> Gets and sets of the SignatureVersion property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UserAgent"> <summary> Gets and sets of the UserAgent property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.RegionEndpoint"> <summary> Gets and sets the RegionEndpoint property. The region constant to use that determines the endpoint to use. If this is not set then the client will fallback to the value of ServiceURL. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ServiceURL"> <summary> Gets and sets of the ServiceURL property. This is an optional property; change it only if you want to try a different service endpoint. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.UseHttp"> <summary> Gets and sets the UseHttp. If this property is set to true, the client attempts to use HTTP protocol, if the target endpoint supports it. By default, this property is set to false. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.AuthenticationRegion"> <summary> Gets and sets the AuthenticationRegion property. Used in AWS4 request signing, this is an optional property; change it only if the region cannot be determined from the service endpoint. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.AuthenticationServiceName"> <summary> Gets and sets the AuthenticationServiceName property. Used in AWS4 request signing, this is the short-form name of the service being called. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.MaxErrorRetry"> <summary> Gets and sets of the MaxErrorRetry property. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.LogResponse"> <summary> Gets and sets the LogResponse. If this property is set to true, the service response is read in its entirety and logged. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ReadEntireResponse"> <summary> Gets and sets the ReadEntireResponse. If this property is set to true, the service response is read in its entirety before being processed. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.BufferSize"> <summary> Gets and Sets the BufferSize property. The BufferSize controls the buffer used to read in from input streams and write out to the request. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProgressUpdateInterval"> <summary> <para> Gets or sets the interval at which progress update events are raised for upload operations. By default, the progress update events are raised at every 100KB of data transferred. </para> <para> If the value of this property is set less than ClientConfig.BufferSize, progress updates events will be raised at the interval specified by ClientConfig.BufferSize. </para> </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ResignRetries"> <summary> Flag on whether to resign requests on retry or not. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.AllowAutoRedirect"> <summary> This flag controls if .NET HTTP infrastructure should follow redirection responses (e.g. HTTP 307 - temporary redirect). </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.LogMetrics"> <summary> Flag on whether to log metrics for service calls. This can be set in the application's configs, as below: <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSLogMetrics" value"true"/> </appSettings> </configuration> </code> </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.DisableLogging"> <summary> Flag on whether to completely disable logging for this client or not. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.ProxyCredentials"> <summary> Credentials to use with a proxy. </summary> </member> <member name="P:Amazon.Runtime.ClientConfig.Timeout"> <summary> Overrides the default request timeout value. </summary> <remarks> <para> If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used to send requests. </para> <para> Please specify a timeout value only if the operation will not complete within the default intervals specified for an HttpWebRequest/HttpClient. </para> </remarks> <exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception> <seealso cref="P:System.Net.HttpWebRequest.Timeout"/> <seealso cref="P:System.Net.Http.HttpClient.Timeout"/> </member> <member name="M:Amazon.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.LifecycleState"> <summary> Constants used for properties of type LifecycleState. </summary> </member> <member name="T:Amazon.Runtime.ConstantClass"> <summary> Base class for constant class that holds the value that will be sent to AWS for the static constants. </summary> </member> <member name="M:Amazon.Runtime.ConstantClass.Intern"> <summary> Attempt to find correct-cased constant value using whatever cased value the user has provided. This is primarily useful for mapping any-cased values from a CLI tool to the specific casing required by the service, avoiding the need for the user to (a) remember the specific case and (b) actually type it correctly. </summary> <returns>The properly cased service constant matching the value</returns> </member> <member name="P:Amazon.Runtime.ConstantClass.Value"> <summary> Gets the value that needs to be used when send the value to AWS </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Detached"> <summary> Constant Detached for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Detaching"> <summary> Constant Detaching for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.EnteringStandby"> <summary> Constant EnteringStandby for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.InService"> <summary> Constant InService for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Pending"> <summary> Constant Pending for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.PendingProceed"> <summary> Constant PendingProceed for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.PendingWait"> <summary> Constant PendingWait for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Quarantined"> <summary> Constant Quarantined for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Standby"> <summary> Constant Standby for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Terminated"> <summary> Constant Terminated for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.Terminating"> <summary> Constant Terminating for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.TerminatingProceed"> <summary> Constant TerminatingProceed for LifecycleState </summary> </member> <member name="F:Amazon.AutoScaling.LifecycleState.TerminatingWait"> <summary> Constant TerminatingWait for LifecycleState </summary> </member> <member name="M:Amazon.AutoScaling.LifecycleState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.AutoScaling.LifecycleState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.AutoScaling.ScalingActivityStatusCode"> <summary> Constants used for properties of type ScalingActivityStatusCode. </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.Cancelled"> <summary> Constant Cancelled for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.Failed"> <summary> Constant Failed for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.InProgress"> <summary> Constant InProgress for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.MidLifecycleAction"> <summary> Constant MidLifecycleAction for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.PendingSpotBidPlacement"> <summary> Constant PendingSpotBidPlacement for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.PreInService"> <summary> Constant PreInService for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.Successful"> <summary> Constant Successful for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.WaitingForELBConnectionDraining"> <summary> Constant WaitingForELBConnectionDraining for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.WaitingForInstanceId"> <summary> Constant WaitingForInstanceId for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.WaitingForInstanceWarmup"> <summary> Constant WaitingForInstanceWarmup for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.WaitingForSpotInstanceId"> <summary> Constant WaitingForSpotInstanceId for ScalingActivityStatusCode </summary> </member> <member name="F:Amazon.AutoScaling.ScalingActivityStatusCode.WaitingForSpotInstanceRequestId"> <summary> Constant WaitingForSpotInstanceRequestId for ScalingActivityStatusCode </summary> </member> <member name="M:Amazon.AutoScaling.ScalingActivityStatusCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.AutoScaling.ScalingActivityStatusCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.AutoScaling.Model.Activity"> <summary> Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance. </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.ActivityId"> <summary> Gets and sets the property ActivityId. <para> 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> The reason the activity began. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Description"> <summary> Gets and sets the property Description. <para> A friendly, more verbose description of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Details"> <summary> Gets and sets the property Details. <para> The details about the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.EndTime"> <summary> Gets and sets the property EndTime. <para> The end time of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.Progress"> <summary> Gets and sets the property Progress. <para> 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> The start time of the activity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Activity.StatusCode"> <summary> Gets and sets the property StatusCode. <para> 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> A friendly, more verbose description of the activity status. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AdjustmentType"> <summary> Describes a policy adjustment type. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html">Dynamic Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AdjustmentType.Type"> <summary> Gets and sets the property Type. <para> The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Alarm"> <summary> Describes an alarm. </summary> </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.AmazonAutoScalingRequest"> <summary> Base class for AutoScaling operation requests. </summary> </member> <member name="T:Amazon.Runtime.AmazonWebServiceRequest"> <summary> Base class for request used by some of the services. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceRequest.TimeoutInternal"> <summary> Overrides the default request timeout value. </summary> <remarks> <para> If the value is set, the value is assigned to the Timeout property of the HTTPWebRequest/HttpClient object used to send requests. </para> <para> Please specify a timeout value only if the operation will not complete within the default intervals specified for an HttpWebRequest/HttpClient. </para> </remarks> <exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception> <seealso cref="P:System.Net.HttpWebRequest.Timeout"/> <seealso cref="P:System.Net.Http.HttpClient.Timeout"/> </member> <member name="P:Amazon.Runtime.AmazonWebServiceRequest.ReadWriteTimeoutInternal"> <summary> Overrides the default read-write timeout value. </summary> <remarks> <para> If the value is set, the value is assigned to the ReadWriteTimeout property of the HTTPWebRequest/WebRequestHandler object used to send requests. </para> <exception cref="T:System.ArgumentNullException">The timeout specified is null.</exception> <exception cref="T:System.ArgumentOutOfRangeException">The timeout specified is less than or equal to zero and is not Infinite.</exception> </remarks> <seealso cref="P:System.Net.HttpWebRequest.ReadWriteTimeout"/> <seealso cref="P:System.Net.Http.WebRequestHandler.ReadWriteTimeout"/> </member> <member name="P:Amazon.Runtime.AmazonWebServiceRequest.UseSigV4"> <summary> This flag specifies if SigV4 will be used for the current request. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceRequest.Expect100Continue"> <summary> Gets or Sets a value indicating if "Expect: 100-continue" HTTP header will be sent by the client for this request. The default value is false. </summary> </member> <member name="T:Amazon.AutoScaling.Model.AttachInstancesRequest"> <summary> Container for the parameters to the AttachInstances operation. Attaches one or more EC2 instances to the specified Auto Scaling group. <para> When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-instance-asg.html">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachInstancesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.Runtime.AmazonWebServiceResponse"> <summary> Abstract class for Response objects, contains only metadata, and no result information. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceResponse.ResponseMetadata"> <summary> Contains additional information about the request, such as the Request Id. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceResponse.ContentLength"> <summary> Returns the content length of the HTTP response. </summary> </member> <member name="P:Amazon.Runtime.AmazonWebServiceResponse.HttpStatusCode"> <summary> Returns the status code of the HTTP response. </summary> </member> <member name="T:Amazon.AutoScaling.Model.AttachLoadBalancersRequest"> <summary> Container for the parameters to the AttachLoadBalancers operation. Attaches one or more load balancers to the specified Auto Scaling group. <para> To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/attach-load-balancer-asg.html">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachLoadBalancersRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachLoadBalancersRequest.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> One or more load balancer names. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AttachLoadBalancersResponse"> <summary> Configuration for accessing Amazon AttachLoadBalancers service </summary> </member> <member name="T:Amazon.AutoScaling.Model.AttachLoadBalancersResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AttachLoadBalancersResponse.AttachLoadBalancersResult"> <summary> Gets and sets the AttachLoadBalancersResult property. Represents the output of a AttachLoadBalancers operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.AutoScalingGroup"> <summary> Describes an Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AutoScalingGroupARN"> <summary> Gets and sets the property AutoScalingGroupARN. <para> The Amazon Resource Name (ARN) of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> One or more Availability Zones for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.CreatedTime"> <summary> Gets and sets the property CreatedTime. <para> The date and time the group was created. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.DefaultCooldown"> <summary> Gets and sets the property DefaultCooldown. <para> The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The desired size of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.EnabledMetrics"> <summary> Gets and sets the property EnabledMetrics. <para> The metrics enabled for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Instances"> <summary> Gets and sets the property Instances. <para> The EC2 instances associated with the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> The name of the associated launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> One or more load balancers associated with the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.MaxSize"> <summary> Gets and sets the property MaxSize. <para> The maximum size of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.MinSize"> <summary> Gets and sets the property MinSize. <para> The minimum size of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.NewInstancesProtectedFromScaleIn"> <summary> Gets and sets the property NewInstancesProtectedFromScaleIn. <para> Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> The name of the placement group into which you'll launch your instances, if any. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Status"> <summary> Gets and sets the property Status. <para> The current state of the group when <a>DeleteAutoScalingGroup</a> is in progress. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.SuspendedProcesses"> <summary> Gets and sets the property SuspendedProcesses. <para> The suspended processes associated with the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.Tags"> <summary> Gets and sets the property Tags. <para> The tags for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.TerminationPolicies"> <summary> Gets and sets the property TerminationPolicies. <para> The termination policies for the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingGroup.VPCZoneIdentifier"> <summary> Gets and sets the property VPCZoneIdentifier. <para> One or more subnet IDs, if applicable, separated by commas. </para> <para> If you specify <code>VPCZoneIdentifier</code> and <code>AvailabilityZones</code>, ensure that the Availability Zones of the subnets match the values for <code>AvailabilityZones</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.AutoScalingInstanceDetails"> <summary> Describes an EC2 instance associated with an Auto Scaling group. </summary> </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 the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the instance. </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 and 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 ID of the 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 the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.LifecycleState"> <summary> Gets and sets the property LifecycleState. <para> The lifecycle state for the instance. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.AutoScalingInstanceDetails.ProtectedFromScaleIn"> <summary> Gets and sets the property ProtectedFromScaleIn. <para> Indicates whether the instance is protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.BlockDeviceMapping"> <summary> Describes a block device mapping. </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The device name exposed to the EC2 instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.Ebs"> <summary> Gets and sets the property Ebs. <para> The information about the Amazon EBS volume. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.NoDevice"> <summary> Gets and sets the property NoDevice. <para> Suppresses a device mapping. </para> <para> If this parameter is true 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. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.BlockDeviceMapping.VirtualName"> <summary> Gets and sets the property VirtualName. <para> The name of the virtual device (for example, <code>ephemeral0</code>). </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest"> <summary> Container for the parameters to the CompleteLifecycleAction operation. Completes the lifecycle action for the specified token or instance with the specified result. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li><b>If you finish before the timeout period ends, complete the lifecycle action.</b></li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group for the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleActionResult"> <summary> Gets and sets the property LifecycleActionResult. <para> The action for the group to take. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleActionToken"> <summary> Gets and sets the property LifecycleActionToken. <para> A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CompleteLifecycleActionRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. <para> The name of the lifecycle hook. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionResponse"> <summary> Configuration for accessing Amazon CompleteLifecycleAction service </summary> </member> <member name="T:Amazon.AutoScaling.Model.CompleteLifecycleActionResult"> <summary> </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.CreateAutoScalingGroupRequest"> <summary> Container for the parameters to the CreateAutoScalingGroup operation. Creates an Auto Scaling group with the specified name and attributes. <para> If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroup.html">Auto Scaling Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. This name must be unique within the scope of your AWS account. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> One or more Availability Zones for the group. This parameter is optional if you specify one or more 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, after a scaling activity completes before another scaling activity can start. The default is 300. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 300. </para> <para> This parameter is required if you are adding an <code>ELB</code> health check. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>. </para> <para> By default, health checks use 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/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance. </para> <para> When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping. </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 an 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 the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> One or more load balancers. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SetUpASLBApp.html">Using a Load Balancer With an 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 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 group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.NewInstancesProtectedFromScaleIn"> <summary> Gets and sets the property NewInstancesProtectedFromScaleIn. <para> Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> The name of the placement group into which you'll launch your instances, if any. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateAutoScalingGroupRequest.TerminationPolicies"> <summary> Gets and sets the property TerminationPolicies. <para> One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html">Controlling Which Instances Auto Scaling Terminates During Scale In</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 for your virtual private cloud (VPC). </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 more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest"> <summary> Container for the parameters to the CreateLaunchConfiguration operation. Creates a launch configuration. <para> If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/LaunchConfiguration.html">Launch Configurations</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.AssociatePublicIpAddress"> <summary> Gets and sets the property AssociatePublicIpAddress. <para> Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you specify this parameter, be sure to specify at least one subnet when you create your group. </para> <para> Default: If the instance is launched into a default subnet, the default is <code>true</code>. If the instance is launched into a nondefault subnet, the default is <code>false</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html">Supported Platforms</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> One or more mappings that specify how block devices are exposed to the instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block Device Mapping</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.ClassicLinkVPCId"> <summary> Gets and sets the property ClassicLinkVPCId. <para> The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.ClassicLinkVPCSecurityGroups"> <summary> Gets and sets the property ClassicLinkVPCSecurityGroups. <para> The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html">Amazon 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> 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 EC2 instances to securely access other AWS resources. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-iam-role.html">Launch 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> The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding an 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 instance to use to create the launch configuration. </para> <para> The new launch configuration derives attributes from the instance, with the exception of the block device mapping. </para> <para> To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-lc-with-instanceID.html">Create a Launch Configuration Using an 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 generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, by specifying <code>False</code>, CloudWatch generates metrics every 5 minutes. For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-instance-monitoring.html">Monitoring Your Auto Scaling Instances and Groups</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type of the EC2 instance. For information about available 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 Compute Cloud 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 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 Key Pairs</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. This name must be unique within the scope of your AWS account. </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> You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>). </para> <para> If you specify this parameter, be sure to specify at least one subnet when you create your group. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html">Launching Auto Scaling Instances in a VPC</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 AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateLaunchConfigurationRequest.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> One or more security groups with which to associate the instances. </para> <para> If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If your instances are launched into a VPC, specify security group IDs. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </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, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html">Launching Spot Instances in Your Auto Scaling Group</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 EC2 instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance Metadata and User Data</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest"> <summary> Container for the parameters to the CreateOrUpdateTags operation. Creates or updates tags for the specified Auto Scaling group. <para> When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/ASTagging.html">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.CreateOrUpdateTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest"> <summary> Container for the parameters to the DeleteAutoScalingGroup operation. Deletes the specified Auto Scaling group. <para> If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. </para> <para> If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action. </para> <para> To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances. </para> <para> To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group to delete. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteAutoScalingGroupRequest.ForceDelete"> <summary> Gets and sets the property ForceDelete. <para> Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLaunchConfigurationRequest"> <summary> Container for the parameters to the DeleteLaunchConfiguration operation. Deletes the specified launch configuration. <para> The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use. </para> </summary> </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.DeleteLifecycleHookRequest"> <summary> Container for the parameters to the DeleteLifecycleHook operation. Deletes the specified lifecycle hook. <para> If there are any outstanding lifecycle actions, they are completed first (<code>ABANDON</code> for launching instances, <code>CONTINUE</code> for terminating instances). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group for the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteLifecycleHookRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. <para> The name of the lifecycle hook. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLifecycleHookResponse"> <summary> Configuration for accessing Amazon DeleteLifecycleHook service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteLifecycleHookResult"> <summary> </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.DeleteNotificationConfigurationRequest"> <summary> Container for the parameters to the DeleteNotificationConfiguration operation. Deletes the specified notification. </summary> </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.DeletePolicyRequest"> <summary> Container for the parameters to the DeletePolicy operation. Deletes the specified Auto Scaling policy. <para> Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action. </para> </summary> </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 Amazon Resource Name (ARN) of the policy. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteScheduledActionRequest"> <summary> Container for the parameters to the DeleteScheduledAction operation. Deletes the specified scheduled action. </summary> </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 to delete. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DeleteTagsRequest"> <summary> Container for the parameters to the DeleteTags operation. Deletes the specified tags. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DeleteTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsRequest"> <summary> Container for the parameters to the DescribeAccountLimits operation. Describes the current Auto Scaling resource limits for your AWS account. <para> For information about requesting an increase in these limits, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsResponse"> <summary> Configuration for accessing Amazon DescribeAccountLimits service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAccountLimitsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.MaxNumberOfAutoScalingGroups"> <summary> Gets and sets the property MaxNumberOfAutoScalingGroups. <para> The maximum number of groups allowed for your AWS account. The default limit is 20 per region. </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. The default limit is 100 per region. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.NumberOfAutoScalingGroups"> <summary> Gets and sets the property NumberOfAutoScalingGroups. <para> The current number of groups for your AWS account. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAccountLimitsResult.NumberOfLaunchConfigurations"> <summary> Gets and sets the property NumberOfLaunchConfigurations. <para> The current number of launch configurations for your AWS account. </para> </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.DescribeAdjustmentTypesRequest"> <summary> Container for the parameters to the DescribeAdjustmentTypes operation. Describes the policy adjustment types for use with <a>PutScalingPolicy</a>. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResponse"> <summary> Configuration for accessing Amazon DescribeAdjustmentTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAdjustmentTypesResult.AdjustmentTypes"> <summary> Gets and sets the property AdjustmentTypes. <para> The policy adjustment types. </para> </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.DescribeAutoScalingGroupsRequest"> <summary> Container for the parameters to the DescribeAutoScalingGroups operation. Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.AutoScalingGroupNames"> <summary> Gets and sets the property AutoScalingGroupNames. <para> The 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 items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResponse"> <summary> Configuration for accessing Amazon DescribeAutoScalingGroups service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> The groups. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingGroupsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </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.DescribeAutoScalingInstancesRequest"> <summary> Container for the parameters to the DescribeAutoScalingInstances operation. Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is 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 items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResponse"> <summary> Configuration for accessing Amazon DescribeAutoScalingInstances service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.AutoScalingInstances"> <summary> Gets and sets the property AutoScalingInstances. <para> The instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </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.DescribeAutoScalingNotificationTypesRequest"> <summary> Container for the parameters to the DescribeAutoScalingNotificationTypes operation. Describes the notification types that are supported by Auto Scaling. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResponse"> <summary> Configuration for accessing Amazon DescribeAutoScalingNotificationTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeAutoScalingNotificationTypesResult.AutoScalingNotificationTypes"> <summary> Gets and sets the property AutoScalingNotificationTypes. <para> One or more of the following notification types: </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="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.DescribeLaunchConfigurationsRequest"> <summary> Container for the parameters to the DescribeLaunchConfigurations operation. Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.LaunchConfigurationNames"> <summary> Gets and sets the property LaunchConfigurationNames. <para> The 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 items to return with this call. The default is 100. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResponse"> <summary> Configuration for accessing Amazon DescribeLaunchConfigurations service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.LaunchConfigurations"> <summary> Gets and sets the property LaunchConfigurations. <para> The launch configurations. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLaunchConfigurationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </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.DescribeLifecycleHooksRequest"> <summary> Container for the parameters to the DescribeLifecycleHooks operation. Describes the lifecycle hooks for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksRequest.LifecycleHookNames"> <summary> Gets and sets the property LifecycleHookNames. <para> The names of one or more lifecycle hooks. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHooksResponse"> <summary> Configuration for accessing Amazon DescribeLifecycleHooks service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHooksResult.LifecycleHooks"> <summary> Gets and sets the property LifecycleHooks. <para> The lifecycle hooks for the specified group. </para> </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.DescribeLifecycleHookTypesRequest"> <summary> Container for the parameters to the DescribeLifecycleHookTypes operation. Describes the available types of lifecycle hooks. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResponse"> <summary> Configuration for accessing Amazon DescribeLifecycleHookTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLifecycleHookTypesResult.LifecycleHookTypes"> <summary> Gets and sets the property LifecycleHookTypes. <para> One or more of the following notification types: </para> <ul> <li> <para> <code>autoscaling:EC2_INSTANCE_LAUNCHING</code> </para> </li> <li> <para> <code>autoscaling:EC2_INSTANCE_TERMINATING</code> </para> </li> </ul> </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.DescribeLoadBalancersRequest"> <summary> Container for the parameters to the DescribeLoadBalancers operation. Describes the load balancers for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLoadBalancersResponse"> <summary> Configuration for accessing Amazon DescribeLoadBalancers service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeLoadBalancersResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersResult.LoadBalancers"> <summary> Gets and sets the property LoadBalancers. <para> The load balancers. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeLoadBalancersResponse.DescribeLoadBalancersResult"> <summary> Gets and sets the DescribeLoadBalancersResult property. Represents the output of a DescribeLoadBalancers operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesRequest"> <summary> Container for the parameters to the DescribeMetricCollectionTypes operation. Describes the available CloudWatch metrics for Auto Scaling. <para> Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResponse"> <summary> Configuration for accessing Amazon DescribeMetricCollectionTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.Granularities"> <summary> Gets and sets the property Granularities. <para> The granularities for the metrics. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeMetricCollectionTypesResult.Metrics"> <summary> Gets and sets the property Metrics. <para> One or more metrics. </para> </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.DescribeNotificationConfigurationsRequest"> <summary> Container for the parameters to the DescribeNotificationConfigurations operation. Describes the notification actions associated with the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.AutoScalingGroupNames"> <summary> Gets and sets the property AutoScalingGroupNames. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResponse"> <summary> Configuration for accessing Amazon DescribeNotificationConfigurations service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeNotificationConfigurationsResult.NotificationConfigurations"> <summary> Gets and sets the property NotificationConfigurations. <para> The notification configurations. </para> </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.DescribePoliciesRequest"> <summary> Container for the parameters to the DescribePolicies operation. Describes the policies for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of items to be returned with each call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.PolicyNames"> <summary> Gets and sets the property PolicyNames. <para> One or more policy names or policy ARNs to be described. If you omit this list, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesRequest.PolicyTypes"> <summary> Gets and sets the property PolicyTypes. <para> One or more policy types. Valid values are <code>SimpleScaling</code> and <code>StepScaling</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribePoliciesResponse"> <summary> Configuration for accessing Amazon DescribePolicies service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribePoliciesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribePoliciesResult.ScalingPolicies"> <summary> Gets and sets the property ScalingPolicies. <para> The scaling policies. </para> </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.DescribeScalingActivitiesRequest"> <summary> Container for the parameters to the DescribeScalingActivities operation. Describes one or more scaling activities for the specified Auto Scaling group. If you omit the <code>ActivityIds</code>, the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.ActivityIds"> <summary> Gets and sets the property ActivityIds. <para> The activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If you specify an Auto Scaling group, 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 group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingActivitiesResponse"> <summary> Configuration for accessing Amazon DescribeScalingActivities service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.Activities"> <summary> Gets and sets the property Activities. <para> The scaling activities. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingActivitiesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </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.DescribeScalingProcessTypesRequest"> <summary> Container for the parameters to the DescribeScalingProcessTypes operation. Describes the scaling process types for use with <a>ResumeProcesses</a> and <a>SuspendProcesses</a>. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResponse"> <summary> Configuration for accessing Amazon DescribeScalingProcessTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScalingProcessTypesResult.Processes"> <summary> Gets and sets the property Processes. <para> The names of the process types. </para> </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.DescribeScheduledActionsRequest"> <summary> Container for the parameters to the DescribeScheduledActions operation. Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the 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 parameter 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 items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsRequest.ScheduledActionNames"> <summary> Gets and sets the property ScheduledActionNames. <para> Describes one or more scheduled actions. If you omit this list, the call describes all scheduled actions. If you specify an unknown scheduled action it is ignored with no error. </para> <para> You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token. </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 parameter is ignored. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScheduledActionsResponse"> <summary> Configuration for accessing Amazon DescribeScheduledActions service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeScheduledActionsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeScheduledActionsResult.ScheduledUpdateGroupActions"> <summary> Gets and sets the property ScheduledUpdateGroupActions. <para> The scheduled actions. </para> </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.DescribeTagsRequest"> <summary> Container for the parameters to the DescribeTags operation. Describes the specified tags. <para> You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results. </para> <para> You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.Filters"> <summary> Gets and sets the property Filters. <para> A filter used to scope the tags to return. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of items to return with this call. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a previous call.) </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTagsResponse"> <summary> Configuration for accessing Amazon DescribeTags service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTagsResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTagsResult.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags. </para> </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.DescribeTerminationPolicyTypesRequest"> <summary> Container for the parameters to the DescribeTerminationPolicyTypes operation. Describes the termination policies supported by Auto Scaling. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResponse"> <summary> Configuration for accessing Amazon DescribeTerminationPolicyTypes service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DescribeTerminationPolicyTypesResult.TerminationPolicyTypes"> <summary> Gets and sets the property TerminationPolicyTypes. <para> The termination policies supported by Auto Scaling (<code>OldestInstance</code>, <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>, <code>ClosestToNextInstanceHour</code>, and <code>Default</code>). </para> </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.DetachInstancesRequest"> <summary> Container for the parameters to the DetachInstances operation. Removes one or more instances from the specified Auto Scaling group. <para> After the instances are detached, you can manage them independently from the rest of the Auto Scaling group. </para> <para> If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/detach-instance-asg.html">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. <para> If <code>True</code>, the Auto Scaling group decrements the desired capacity value by the number of instances detached. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachInstancesResponse"> <summary> Configuration for accessing Amazon DetachInstances service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachInstancesResult.Activities"> <summary> Gets and sets the property Activities. <para> The activities related to detaching the instances from the Auto Scaling group. </para> </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.DetachLoadBalancersRequest"> <summary> Container for the parameters to the DetachLoadBalancers operation. Removes one or more load balancers from the specified Auto Scaling group. <para> When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachLoadBalancersRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachLoadBalancersRequest.LoadBalancerNames"> <summary> Gets and sets the property LoadBalancerNames. <para> One or more load balancer names. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachLoadBalancersResponse"> <summary> Configuration for accessing Amazon DetachLoadBalancers service </summary> </member> <member name="T:Amazon.AutoScaling.Model.DetachLoadBalancersResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DetachLoadBalancersResponse.DetachLoadBalancersResult"> <summary> Gets and sets the DetachLoadBalancersResult property. Represents the output of a DetachLoadBalancers operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest"> <summary> Container for the parameters to the DisableMetricsCollection operation. Disables monitoring of the specified metrics for the specified Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name or Amazon Resource Name (ARN) of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.DisableMetricsCollectionRequest.Metrics"> <summary> Gets and sets the property Metrics. <para> One or more of the following metrics. If you omit this parameter, all metrics are disabled. </para> <ul> <li> <para> <code>GroupMinSize</code> </para> </li> <li> <para> <code>GroupMaxSize</code> </para> </li> <li> <para> <code>GroupDesiredCapacity</code> </para> </li> <li> <para> <code>GroupInServiceInstances</code> </para> </li> <li> <para> <code>GroupPendingInstances</code> </para> </li> <li> <para> <code>GroupStandbyInstances</code> </para> </li> <li> <para> <code>GroupTerminatingInstances</code> </para> </li> <li> <para> <code>GroupTotalInstances</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Ebs"> <summary> Describes an Amazon EBS volume. </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the volume is deleted on instance termination. </para> <para> Default: <code>true</code> </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. 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> </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) to provision for the volume. </para> <para> Constraint: Required when the volume type is <code>io1</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the snapshot. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.VolumeSize"> <summary> Gets and sets the property VolumeSize. <para> The volume size, in GiB. For <code>standard</code> volumes, specify a value from 1 to 1,024. For <code>io1</code> volumes, specify a value from 4 to 16,384. For <code>gp2</code> volumes, specify a value from 1 to 16,384. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. </para> <para> Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Ebs.VolumeType"> <summary> Gets and sets the property VolumeType. <para> The volume type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> </para> <para> Default: <code>standard</code> </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnabledMetric"> <summary> Describes an enabled metric. </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnabledMetric.Granularity"> <summary> Gets and sets the property Granularity. <para> The granularity of the metric. The only valid value is <code>1Minute</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnabledMetric.Metric"> <summary> Gets and sets the property Metric. <para> One of the following metrics: </para> <ul> <li> <para> <code>GroupMinSize</code> </para> </li> <li> <para> <code>GroupMaxSize</code> </para> </li> <li> <para> <code>GroupDesiredCapacity</code> </para> </li> <li> <para> <code>GroupInServiceInstances</code> </para> </li> <li> <para> <code>GroupPendingInstances</code> </para> </li> <li> <para> <code>GroupStandbyInstances</code> </para> </li> <li> <para> <code>GroupTerminatingInstances</code> </para> </li> <li> <para> <code>GroupTotalInstances</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest"> <summary> Container for the parameters to the EnableMetricsCollection operation. Enables monitoring of the specified metrics for the specified Auto Scaling group. <para> You can only enable metrics collection if <code>InstanceMonitoring</code> in the launch configuration for the group is set to <code>True</code>. </para> </summary> </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. The only valid value is <code>1Minute</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnableMetricsCollectionRequest.Metrics"> <summary> Gets and sets the property Metrics. <para> One or more of the following metrics. If you omit this parameter, all metrics are enabled. </para> <ul> <li> <para> <code>GroupMinSize</code> </para> </li> <li> <para> <code>GroupMaxSize</code> </para> </li> <li> <para> <code>GroupDesiredCapacity</code> </para> </li> <li> <para> <code>GroupInServiceInstances</code> </para> </li> <li> <para> <code>GroupPendingInstances</code> </para> </li> <li> <para> <code>GroupStandbyInstances</code> </para> </li> <li> <para> <code>GroupTerminatingInstances</code> </para> </li> <li> <para> <code>GroupTotalInstances</code> </para> </li> </ul> <para> Note that the <code>GroupStandbyInstances</code> metric is not enabled by default. You must explicitly request this metric. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyRequest"> <summary> Container for the parameters to the EnterStandby operation. Moves the specified instances into <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyRequest.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.EnterStandbyRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instances to move into <code>Standby</code> mode. You must specify at least one instance ID. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. <para> Specifies whether the instances moved to <code>Standby</code> mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to <code>Standby</code> mode. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyResponse"> <summary> Configuration for accessing Amazon EnterStandby service </summary> </member> <member name="T:Amazon.AutoScaling.Model.EnterStandbyResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.EnterStandbyResult.Activities"> <summary> Gets and sets the property Activities. <para> The activities related to moving instances into <code>Standby</code> mode. </para> </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.ExecutePolicyRequest"> <summary> Container for the parameters to the ExecutePolicy operation. Executes the specified policy. </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.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.ExecutePolicyRequest.BreachThreshold"> <summary> Gets and sets the property BreachThreshold. <para> The breach threshold for the alarm. </para> <para> This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.HonorCooldown"> <summary> Gets and sets the property HonorCooldown. <para> If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete. </para> <para> This parameter is not supported if the policy type is <code>StepScaling</code>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExecutePolicyRequest.MetricValue"> <summary> Gets and sets the property MetricValue. <para> The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59. </para> <para> If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error. </para> <para> This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise. </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. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyRequest"> <summary> Container for the parameters to the ExitStandby operation. Moves the specified instances out of <code>Standby</code> mode. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyRequest.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.ExitStandbyRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. You must specify at least one instance ID. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyResponse"> <summary> Configuration for accessing Amazon ExitStandby service </summary> </member> <member name="T:Amazon.AutoScaling.Model.ExitStandbyResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ExitStandbyResult.Activities"> <summary> Gets and sets the property Activities. <para> The activities related to moving instances out of <code>Standby</code> mode. </para> </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.Filter"> <summary> Describes a filter. </summary> </member> <member name="P:Amazon.AutoScaling.Model.Filter.Name"> <summary> Gets and sets the property Name. <para> The name of the filter. The valid 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> Describes an EC2 instance. </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which the instance is running. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.HealthStatus"> <summary> Gets and sets the property HealthStatus. <para> The health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Auto Scaling should terminate and replace it. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the 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 the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.LifecycleState"> <summary> Gets and sets the property LifecycleState. <para> A description of the current lifecycle state. Note that the <code>Quarantined</code> state is not used. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Instance.ProtectedFromScaleIn"> <summary> Gets and sets the property ProtectedFromScaleIn. <para> Indicates whether the instance is protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.InstanceMonitoring"> <summary> Describes whether instance monitoring is enabled. </summary> </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.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> Describes a launch configuration. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.AssociatePublicIpAddress"> <summary> Gets and sets the property AssociatePublicIpAddress. <para> [EC2-VPC] Indicates whether to assign a public IP address to each instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> A block device mapping, which specifies the block devices for the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.ClassicLinkVPCId"> <summary> Gets and sets the property ClassicLinkVPCId. <para> The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.ClassicLinkVPCSecurityGroups"> <summary> Gets and sets the property ClassicLinkVPCSecurityGroups. <para> The IDs of one or more security groups for the VPC specified in <code>ClassicLinkVPCId</code>. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.CreatedTime"> <summary> Gets and sets the property CreatedTime. <para> The creation date and time for the launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Controls whether the instance is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the Amazon Machine Image (AMI). </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. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type for the instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel associated with the AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.LaunchConfigurationARN"> <summary> Gets and sets the property LaunchConfigurationARN. <para> The Amazon Resource Name (ARN) of the launch configuration. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.LaunchConfigurationName"> <summary> Gets and sets the property LaunchConfigurationName. <para> 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> The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk associated with the AMI. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> The security groups to associate with the instances. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LaunchConfiguration.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> 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 instances. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.LifecycleHook"> <summary> Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either: <ul> <li>Pause the instance after it launches, but before it is put into service</li> <li>Pause the instance as it terminates, but before it is fully terminated</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group for the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.DefaultResult"> <summary> Gets and sets the property DefaultResult. <para> Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.GlobalTimeout"> <summary> Gets and sets the property GlobalTimeout. <para> The maximum time, in seconds, that an instance can remain in a <code>Pending:Wait</code> or <code>Terminating:Wait</code> state. The default is 172800 seconds (48 hours). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.HeartbeatTimeout"> <summary> Gets and sets the property HeartbeatTimeout. <para> The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. <para> The name of the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.LifecycleTransition"> <summary> Gets and sets the property LifecycleTransition. <para> The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.NotificationMetadata"> <summary> Gets and sets the property NotificationMetadata. <para> Additional information that you want to include any time Auto Scaling sends a message to the notification target. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.NotificationTargetARN"> <summary> Gets and sets the property NotificationTargetARN. <para> The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following: </para> <ul> <li>Lifecycle action token</li> <li>User account ID</li> <li>Name of the Auto Scaling group</li> <li>Lifecycle hook name</li> <li>EC2 instance ID</li> <li>Lifecycle transition</li> <li>Notification metadata</li> </ul> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LifecycleHook.RoleARN"> <summary> Gets and sets the property RoleARN. <para> The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. </para> </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.LoadBalancerState"> <summary> Describes the state of a load balancer. </summary> </member> <member name="P:Amazon.AutoScaling.Model.LoadBalancerState.LoadBalancerName"> <summary> Gets and sets the property LoadBalancerName. <para> The name of the load balancer. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.LoadBalancerState.State"> <summary> Gets and sets the property State. <para> One of the following load balancer states: </para> <ul> <li> <para> <code>Adding</code> - The instances in the group are being registered with the load balancer. </para> </li> <li> <para> <code>Added</code> - All instances in the group are registered with the load balancer. </para> </li> <li> <para> <code>InService</code> - At least one instance in the group passed an ELB health check. </para> </li> <li> <para> <code>Removing</code> - The instances are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances. </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.MetricCollectionType"> <summary> Describes a metric. </summary> </member> <member name="P:Amazon.AutoScaling.Model.MetricCollectionType.Metric"> <summary> Gets and sets the property Metric. <para> One of the following metrics: </para> <ul> <li> <para> <code>GroupMinSize</code> </para> </li> <li> <para> <code>GroupMaxSize</code> </para> </li> <li> <para> <code>GroupDesiredCapacity</code> </para> </li> <li> <para> <code>GroupInServiceInstances</code> </para> </li> <li> <para> <code>GroupPendingInstances</code> </para> </li> <li> <para> <code>GroupStandbyInstances</code> </para> </li> <li> <para> <code>GroupTerminatingInstances</code> </para> </li> <li> <para> <code>GroupTotalInstances</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.MetricGranularityType"> <summary> Describes a granularity of a metric. </summary> </member> <member name="P:Amazon.AutoScaling.Model.MetricGranularityType.Granularity"> <summary> Gets and sets the property Granularity. <para> The granularity. The only valid value is <code>1Minute</code>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.NotificationConfiguration"> <summary> Describes a notification. </summary> </member> <member name="P:Amazon.AutoScaling.Model.NotificationConfiguration.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.NotificationConfiguration.NotificationType"> <summary> Gets and sets the property NotificationType. <para> One of the following event notification types: </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="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> Describes a process type. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html#process-types">Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ProcessType.ProcessName"> <summary> Gets and sets the property ProcessName. <para> One of the following processes: </para> <ul> <li> <para> <code>Launch</code> </para> </li> <li> <para> <code>Terminate</code> </para> </li> <li> <para> <code>AddToLoadBalancer</code> </para> </li> <li> <para> <code>AlarmNotification</code> </para> </li> <li> <para> <code>AZRebalance</code> </para> </li> <li> <para> <code>HealthCheck</code> </para> </li> <li> <para> <code>ReplaceUnhealthy</code> </para> </li> <li> <para> <code>ScheduledActions</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookRequest"> <summary> Container for the parameters to the PutLifecycleHook operation. Creates or updates a lifecycle hook for the specified Auto Scaling Group. <para> A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates. </para> <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li><b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b></li> <li>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group to which you want to assign the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.DefaultResult"> <summary> Gets and sets the property DefaultResult. <para> Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value is <code>ABANDON</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.HeartbeatTimeout"> <summary> Gets and sets the property HeartbeatTimeout. <para> The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>. The default is 3600 seconds (1 hour). </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. <para> The name of the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.LifecycleTransition"> <summary> Gets and sets the property LifecycleTransition. <para> The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>. </para> <para> This parameter is required for new lifecycle hooks, but optional when updating existing hooks. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.NotificationMetadata"> <summary> Gets and sets the property NotificationMetadata. <para> Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.NotificationTargetARN"> <summary> Gets and sets the property NotificationTargetARN. <para> The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN. </para> <para> The notification messages sent to the target include the following information: </para> <ul> <li><b>AutoScalingGroupName</b>. The name of the Auto Scaling group.</li> <li><b>AccountId</b>. The AWS account ID.</li> <li><b>LifecycleTransition</b>. The lifecycle hook type.</li> <li><b>LifecycleActionToken</b>. The lifecycle action token.</li> <li><b>EC2InstanceId</b>. The EC2 instance ID.</li> <li><b>LifecycleHookName</b>. The name of the lifecycle hook.</li> <li><b>NotificationMetadata</b>. User-defined information.</li> </ul> <para> This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic. </para> <para> When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>"Event": "autoscaling:TEST_NOTIFICATION"</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutLifecycleHookRequest.RoleARN"> <summary> Gets and sets the property RoleARN. <para> The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. </para> <para> This parameter is required for new lifecycle hooks, but optional when updating existing hooks. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookResponse"> <summary> Configuration for accessing Amazon PutLifecycleHook service </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutLifecycleHookResult"> <summary> </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.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">Getting Notifications When Your Auto Scaling Group Changes</a> in the <i>Auto Scaling Developer Guide</i>. </para> <para> This configuration overwrites an existing configuration. </para> </summary> </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.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 parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request. <para> If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.AdjustmentType"> <summary> Gets and sets the property AdjustmentType. <para> The adjustment type. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html">Dynamic Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </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 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. If this parameter is not specified, the default cooldown period for the group applies. </para> <para> This parameter is not supported unless the policy type is <code>SimpleScaling</code>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.EstimatedInstanceWarmup"> <summary> Gets and sets the property EstimatedInstanceWarmup. <para> The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group. </para> <para> This parameter is not supported if the policy type is <code>SimpleScaling</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.MetricAggregationType"> <summary> Gets and sets the property MetricAggregationType. <para> The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>. </para> <para> This parameter is not supported if the policy type is <code>SimpleScaling</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.MinAdjustmentMagnitude"> <summary> Gets and sets the property MinAdjustmentMagnitude. <para> The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.MinAdjustmentStep"> <summary> Gets and sets the property MinAdjustmentStep. <para> Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code> instead. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.PolicyName"> <summary> Gets and sets the property PolicyName. <para> The name of the policy. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.PolicyType"> <summary> Gets and sets the property PolicyType. <para> The policy type. Valid values are <code>SimpleScaling</code> and <code>StepScaling</code>. If the policy type is null, the value is treated as <code>SimpleScaling</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.ScalingAdjustment"> <summary> Gets and sets the property ScalingAdjustment. <para> The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. </para> <para> This parameter is required if the policy type is <code>SimpleScaling</code> and not supported otherwise. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyRequest.StepAdjustments"> <summary> Gets and sets the property StepAdjustments. <para> A set of adjustments that enable you to scale based on the size of the alarm breach. </para> <para> This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScalingPolicyResponse"> <summary> Configuration for accessing Amazon PutScalingPolicy service </summary> </member> <member name="T:Amazon.AutoScaling.Model.PutScalingPolicyResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScalingPolicyResult.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.PutScalingPolicyResponse.PutScalingPolicyResult"> <summary> Gets and sets the PutScalingPolicyResult property. Represents the output of a PutScalingPolicy operation. </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 more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/schedule_time.html">Scheduled Scaling</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.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.PutScheduledUpdateGroupActionRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of 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 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 more information, see <a href="http://en.wikipedia.org/wiki/Cron">Cron</a> in Wikipedia. </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, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only (for example, <code>2014-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 starts and stops. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.PutScheduledUpdateGroupActionRequest.Time"> <summary> Gets and sets the property Time. <para> This parameter is deprecated. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest"> <summary> Container for the parameters to the RecordLifecycleActionHeartbeat operation. Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>. <para> This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group: </para> <ol> <li>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</li> <li>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</li> <li>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</li> <li><b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b></li> <li>If you finish before the timeout period ends, complete the lifecycle action.</li> </ol> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html">Auto Scaling Lifecycle</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the Auto Scaling group for the hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.LifecycleActionToken"> <summary> Gets and sets the property LifecycleActionToken. <para> A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatRequest.LifecycleHookName"> <summary> Gets and sets the property LifecycleHookName. <para> The name of the lifecycle hook. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResponse"> <summary> Configuration for accessing Amazon RecordLifecycleActionHeartbeat service </summary> </member> <member name="T:Amazon.AutoScaling.Model.RecordLifecycleActionHeartbeatResult"> <summary> </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.ResourceContentionException"> <summary> AutoScaling exception </summary> </member> <member name="M:Amazon.AutoScaling.Model.ResourceContentionException.#ctor(System.String)"> <summary> Constructs a new ResourceContentionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </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 the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </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> One or more of the following processes: </para> <ul> <li> <para> <code>Launch</code> </para> </li> <li> <para> <code>Terminate</code> </para> </li> <li> <para> <code>HealthCheck</code> </para> </li> <li> <para> <code>ReplaceUnhealthy</code> </para> </li> <li> <para> <code>AZRebalance</code> </para> </li> <li> <para> <code>AlarmNotification</code> </para> </li> <li> <para> <code>ScheduledActions</code> </para> </li> <li> <para> <code>AddToLoadBalancer</code> </para> </li> </ul> </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> Describes a scaling policy. </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.AdjustmentType"> <summary> Gets and sets the property AdjustmentType. <para> The adjustment type, which specifies how <code>ScalingAdjustment</code> is interpreted. 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> The 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.EstimatedInstanceWarmup"> <summary> Gets and sets the property EstimatedInstanceWarmup. <para> The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.MetricAggregationType"> <summary> Gets and sets the property MetricAggregationType. <para> The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.MinAdjustmentMagnitude"> <summary> Gets and sets the property MinAdjustmentMagnitude. <para> The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.MinAdjustmentStep"> <summary> Gets and sets the property MinAdjustmentStep. <para> Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code> instead. </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.PolicyType"> <summary> Gets and sets the property PolicyType. <para> The policy type. Valid values are <code>SimpleScaling</code> and <code>StepScaling</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.ScalingAdjustment"> <summary> Gets and sets the property ScalingAdjustment. <para> The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScalingPolicy.StepAdjustments"> <summary> Gets and sets the property StepAdjustments. <para> A set of adjustments that enable you to scale based on the size of the alarm breach. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction"> <summary> Describes a scheduled update to an Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </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 the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.EndTime"> <summary> Gets and sets the property EndTime. <para> The date and time that the action is scheduled to end. This date and time 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 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 group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.Recurrence"> <summary> Gets and sets the property Recurrence. <para> The recurring schedule for the action. </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 the scheduled action. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.ScheduledActionName"> <summary> Gets and sets the property ScheduledActionName. <para> The name of the scheduled action. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.ScheduledUpdateGroupAction.StartTime"> <summary> Gets and sets the property StartTime. <para> The date and time that the action is scheduled to begin. This date and time 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> This parameter is deprecated. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetDesiredCapacityRequest"> <summary> Container for the parameters to the SetDesiredCapacity operation. Sets the size of the specified Auto Scaling group. <para> For more information about desired capacity, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/WhatIsAutoScaling.html">What Is Auto Scaling?</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </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 number of EC2 instances that should be running in 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. Specify <code>True</code> to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceHealthRequest"> <summary> Container for the parameters to the SetInstanceHealth operation. Sets the health status of the specified instance. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </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 ID of the 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 description of the health check grace period for <a>CreateAutoScalingGroup</a>. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceProtectionRequest"> <summary> Container for the parameters to the SetInstanceProtection operation. Updates the instance protection settings of the specified instances. <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html#instance-protection">Instance Protection</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceProtectionRequest.AutoScalingGroupName"> <summary> Gets and sets the property AutoScalingGroupName. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceProtectionRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceProtectionRequest.ProtectedFromScaleIn"> <summary> Gets and sets the property ProtectedFromScaleIn. <para> Indicates whether the instance is protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceProtectionResponse"> <summary> Configuration for accessing Amazon SetInstanceProtection service </summary> </member> <member name="T:Amazon.AutoScaling.Model.SetInstanceProtectionResult"> <summary> </summary> </member> <member name="P:Amazon.AutoScaling.Model.SetInstanceProtectionResponse.SetInstanceProtectionResult"> <summary> Gets and sets the SetInstanceProtectionResult property. Represents the output of a SetInstanceProtection operation. </summary> </member> <member name="T:Amazon.AutoScaling.Model.StepAdjustment"> <summary> Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. <para> For the following examples, suppose that you have an alarm with a breach threshold of 50: </para> <ul> <li> <para> If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10. </para> </li> <li> <para> If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0. </para> </li> </ul> <para> There are a few rules for the step adjustments for your step policy: </para> <ul> <li> <para> The ranges of your step adjustments can't overlap or have a gap. </para> </li> <li> <para> At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound. </para> </li> <li> <para> At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound. </para> </li> <li> <para> The upper and lower bound can't be null in the same step adjustment. </para> </li> </ul> </summary> </member> <member name="P:Amazon.AutoScaling.Model.StepAdjustment.MetricIntervalLowerBound"> <summary> Gets and sets the property MetricIntervalLowerBound. <para> The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.StepAdjustment.MetricIntervalUpperBound"> <summary> Gets and sets the property MetricIntervalUpperBound. <para> The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. </para> <para> The upper bound must be greater than the lower bound. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.StepAdjustment.ScalingAdjustment"> <summary> Gets and sets the property ScalingAdjustment. <para> The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.SuspendedProcess"> <summary> Describes an Auto Scaling process that has been suspended. For more information, see <a>ProcessType</a>. </summary> </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 the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group. <para> Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly. </para> <para> To resume processes that have been suspended, use <a>ResumeProcesses</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US_SuspendResume.html">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </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> One or more of the following processes: </para> <ul> <li> <para> <code>Launch</code> </para> </li> <li> <para> <code>Terminate</code> </para> </li> <li> <para> <code>HealthCheck</code> </para> </li> <li> <para> <code>ReplaceUnhealthy</code> </para> </li> <li> <para> <code>AZRebalance</code> </para> </li> <li> <para> <code>AlarmNotification</code> </para> </li> <li> <para> <code>ScheduledActions</code> </para> </li> <li> <para> <code>AddToLoadBalancer</code> </para> </li> </ul> </summary> </member> <member name="T:Amazon.AutoScaling.Model.Tag"> <summary> Describes a tag for an Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The tag key. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.PropagateAtLaunch"> <summary> Gets and sets the property PropagateAtLaunch. <para> Determines whether the tag is added to new instances as they are launched in the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of resource. The only supported value is <code>auto-scaling-group</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The tag value. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TagDescription"> <summary> Describes a tag for an Auto Scaling group. </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.Key"> <summary> Gets and sets the property Key. <para> The tag key. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.PropagateAtLaunch"> <summary> Gets and sets the property PropagateAtLaunch. <para> Determines whether the tag is added to new instances as they are launched in the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of resource. The only supported value is <code>auto-scaling-group</code>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TagDescription.Value"> <summary> Gets and sets the property Value. <para> The tag value. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest"> <summary> Container for the parameters to the TerminateInstanceInAutoScalingGroup operation. Terminates the specified instance and optionally adjusts the desired group size. <para> This call simply makes a termination request. The instance is not terminated immediately. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupRequest.ShouldDecrementDesiredCapacity"> <summary> Gets and sets the property ShouldDecrementDesiredCapacity. <para> If <code>true</code>, terminating the instance also decrements the size of the Auto Scaling group. </para> </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResponse"> <summary> Configuration for accessing Amazon TerminateInstanceInAutoScalingGroup service </summary> </member> <member name="T:Amazon.AutoScaling.Model.TerminateInstanceInAutoScalingGroupResult"> <summary> </summary> </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="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.UpdateAutoScalingGroupRequest"> <summary> Container for the parameters to the UpdateAutoScalingGroup operation. Updates the configuration for the specified Auto Scaling group. <para> To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>. </para> <para> The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected. </para> <para> Note the following: </para> <ul> <li> <para> If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>. </para> </li> <li> <para> If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>. </para> </li> <li> <para> All other optional parameters are left unchanged if not specified. </para> </li> </ul> </summary> </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> One or more 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 another scaling activity can start. The default is 300. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/Cooldown.html">Auto Scaling Cooldowns</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.DesiredCapacity"> <summary> Gets and sets the property DesiredCapacity. <para> The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.HealthCheckGracePeriod"> <summary> Gets and sets the property HealthCheckGracePeriod. <para> The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 300. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html">Health Checks</a> in the <i>Auto Scaling Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.HealthCheckType"> <summary> Gets and sets the property HealthCheckType. <para> The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>. </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.NewInstancesProtectedFromScaleIn"> <summary> Gets and sets the property NewInstancesProtectedFromScaleIn. <para> Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in. </para> </summary> </member> <member name="P:Amazon.AutoScaling.Model.UpdateAutoScalingGroupRequest.PlacementGroup"> <summary> Gets and sets the property PlacementGroup. <para> The name of the placement group into which you'll launch your instances, if any. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </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, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingBehavior.InstanceTermination.html">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in 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 ID of the subnet, if you are launching into a VPC. 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, see <a href="http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/asg-in-vpc.html">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling Developer Guide</i>. </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.AttachLoadBalancersRequestMarshaller"> <summary> AttachLoadBalancers Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.AttachLoadBalancersResponseUnmarshaller"> <summary> Response Unmarshaller for AttachLoadBalancers operation </summary> </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.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.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.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.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.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.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.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.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.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.DescribeLoadBalancersRequestMarshaller"> <summary> DescribeLoadBalancers Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DescribeLoadBalancersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLoadBalancers operation </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.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.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.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.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.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.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.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.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.DetachLoadBalancersRequestMarshaller"> <summary> DetachLoadBalancers Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.DetachLoadBalancersResponseUnmarshaller"> <summary> Response Unmarshaller for DetachLoadBalancers operation </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.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.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.LoadBalancerStateUnmarshaller"> <summary> Response Unmarshaller for LoadBalancerState 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.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.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.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.SetInstanceProtectionRequestMarshaller"> <summary> SetInstanceProtection Request Marshaller </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.SetInstanceProtectionResponseUnmarshaller"> <summary> Response Unmarshaller for SetInstanceProtection operation </summary> </member> <member name="T:Amazon.AutoScaling.Model.Internal.MarshallTransformations.StepAdjustmentUnmarshaller"> <summary> Response Unmarshaller for StepAdjustment Object </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.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.AWSSupport.AmazonAWSSupportClient"> <summary> Implementation for accessing AWSSupport AWS Support <para> The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format. </para> <para> The AWS Support service also exposes a set of <a href="https://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </para> <para> The following list describes the AWS Support case management operations: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li> <li> <b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li> <li> <b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li> </ul> <para> The following list describes the operations available from the AWS Support service for Trusted Advisor: </para> <ul> <li> <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> <li> <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li> <li> <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li> <li> <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li> </ul> <para> For authentication of requests, AWS Support uses <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> See <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </para> </summary> </member> <member name="T:Amazon.AWSSupport.IAmazonAWSSupport"> <summary> Interface for accessing AWSSupport AWS Support <para> The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format. </para> <para> The AWS Support service also exposes a set of <a href="https://aws.amazon.com/premiumsupport/trustedadvisor/">Trusted Advisor</a> features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks. </para> <para> The following list describes the AWS Support case management operations: </para> <ul> <li> <b>Service names, issue categories, and available severity levels. </b>The <a>DescribeServices</a> and <a>DescribeSeverityLevels</a> operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the <a>CreateCase</a> operation. </li> <li> <b>Case creation, case details, and case resolution.</b> The <a>CreateCase</a>, <a>DescribeCases</a>, <a>DescribeAttachment</a>, and <a>ResolveCase</a> operations create AWS Support cases, retrieve information about cases, and resolve cases.</li> <li> <b>Case communication.</b> The <a>DescribeCommunications</a>, <a>AddCommunicationToCase</a>, and <a>AddAttachmentsToSet</a> operations retrieve and add communications and attachments to AWS Support cases. </li> </ul> <para> The following list describes the operations available from the AWS Support service for Trusted Advisor: </para> <ul> <li> <a>DescribeTrustedAdvisorChecks</a> returns the list of checks that run against your AWS resources.</li> <li>Using the <code>CheckId</code> for a specific check returned by <a>DescribeTrustedAdvisorChecks</a>, you can call <a>DescribeTrustedAdvisorCheckResult</a> to obtain the results for the check you specified.</li> <li> <a>DescribeTrustedAdvisorCheckSummaries</a> returns summarized results for one or more Trusted Advisor checks.</li> <li> <a>RefreshTrustedAdvisorCheck</a> requests that Trusted Advisor rerun a specified check. </li> <li> <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> reports the refresh status of one or more checks. </li> </ul> <para> For authentication of requests, AWS Support uses <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> See <a href="http://docs.aws.amazon.com/awssupport/latest/user/Welcome.html">About the AWS Support API</a> in the <i>AWS Support User Guide</i> for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources. </para> </summary> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest)"> <summary> Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet service method.</param> <returns>The response from the AddAttachmentsToSet service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentLimitExceededException"> The limit for the number of attachment sets created in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException"> A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginAddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddAttachmentsToSet operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.EndAddAttachmentsToSet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddAttachmentsToSet.</param> <returns>Returns a AddAttachmentsToSetResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para> <para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase service method.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginAddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndAddCommunicationToCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddCommunicationToCase operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddCommunicationToCase.</param> <returns>Returns a AddCommunicationToCaseResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li> </ol> <note> <para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para> </note> <para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCase service method.</param> <returns>The response from the CreateCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> The case creation limit for the account has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginCreateCase(Amazon.AWSSupport.Model.CreateCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCase operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndCreateCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCase operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCase.</param> <returns>Returns a CreateCaseResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest)"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment service method.</param> <returns>The response from the DescribeAttachment service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentIdNotFoundException"> An attachment with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException"> The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAttachment operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAttachment operation.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.EndDescribeAttachment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAttachment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAttachment.</param> <returns>Returns a DescribeAttachmentResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> The response returns the following in JSON format: </para> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases service method.</param> <returns>The response from the DescribeCases service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeCases(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCases operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCases.</param> <returns>Returns a DescribeCasesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications service method.</param> <returns>The response from the DescribeCommunications service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeCommunications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCommunications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCommunications.</param> <returns>Returns a DescribeCommunicationsResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeServices"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeSeverityLevels"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels service method.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeSeverityLevels(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSeverityLevels operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSeverityLevels.</param> <returns>Returns a DescribeSeverityLevelsResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeTrustedAdvisorCheckRefreshStatuses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckRefreshStatuses.</param> <returns>Returns a DescribeTrustedAdvisorCheckRefreshStatusesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <para> In addition, the response contains these fields: </para> <ul> <li> <b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeTrustedAdvisorCheckResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckResult.</param> <returns>Returns a DescribeTrustedAdvisorCheckResultResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeTrustedAdvisorChecks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorChecks.</param> <returns>Returns a DescribeTrustedAdvisorChecksResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginDescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndDescribeTrustedAdvisorCheckSummaries(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckSummaries.</param> <returns>Returns a DescribeTrustedAdvisorCheckSummariesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para> <ul> <li> <b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginRefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndRefreshTrustedAdvisorCheck(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRefreshTrustedAdvisorCheck.</param> <returns>Returns a RefreshTrustedAdvisorCheckResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase service method.</param> <returns>The response from the ResolveCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.IAmazonAWSSupport.BeginResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonAWSSupport.EndResolveCase(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResolveCase operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResolveCase.</param> <returns>Returns a ResolveCaseResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Credentials and an AmazonAWSSupportClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.#ctor(System.String,System.String,System.String,Amazon.AWSSupport.AmazonAWSSupportConfig)"> <summary> Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an AmazonAWSSupportClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonAWSSupportClient Configuration Object</param> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest)"> <summary> Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet service method.</param> <returns>The response from the AddAttachmentsToSet service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentLimitExceededException"> The limit for the number of attachment sets created in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException"> A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginAddAttachmentsToSet(Amazon.AWSSupport.Model.AddAttachmentsToSetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="request">Container for the necessary parameters to execute the AddAttachmentsToSet operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddAttachmentsToSet operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndAddAttachmentsToSet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddAttachmentsToSet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddAttachmentsToSet.</param> <returns>Returns a AddAttachmentsToSetResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.AddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest)"> <summary> Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para> <para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase service method.</param> <returns>The response from the AddCommunicationToCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginAddCommunicationToCase(Amazon.AWSSupport.Model.AddCommunicationToCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddCommunicationToCase operation. </summary> <param name="request">Container for the necessary parameters to execute the AddCommunicationToCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddCommunicationToCase.</param> <returns>Returns a AddCommunicationToCaseResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.CreateCase(Amazon.AWSSupport.Model.CreateCaseRequest)"> <summary> Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li> </ol> <note> <para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para> </note> <para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateCase service method.</param> <returns>The response from the CreateCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> The expiration time of the attachment set has passed. The set expires 1 hour after it is created. </exception> <exception cref="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> An attachment set with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> The case creation limit for the account has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginCreateCase(Amazon.AWSSupport.Model.CreateCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCase operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCase.</param> <returns>Returns a CreateCaseResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest)"> <summary> Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment service method.</param> <returns>The response from the DescribeAttachment service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.AttachmentIdNotFoundException"> An attachment with the specified ID could not be found. </exception> <exception cref="T:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException"> The limit for the number of <a>DescribeAttachment</a> requests in a short period of time has been exceeded. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeAttachment(Amazon.AWSSupport.Model.DescribeAttachmentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAttachment operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAttachment operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAttachment operation.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.EndDescribeAttachment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAttachment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAttachment.</param> <returns>Returns a DescribeAttachmentResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest)"> <summary> Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> The response returns the following in JSON format: </para> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases service method.</param> <returns>The response from the DescribeCases service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeCases(Amazon.AWSSupport.Model.DescribeCasesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCases operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCases operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCases.</param> <returns>Returns a DescribeCasesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest)"> <summary> Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications service method.</param> <returns>The response from the DescribeCommunications service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeCommunications(Amazon.AWSSupport.Model.DescribeCommunicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCommunications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCommunications operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCommunications.</param> <returns>Returns a DescribeCommunicationsResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest)"> <summary> Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeServices(Amazon.AWSSupport.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest)"> <summary> Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels service method.</param> <returns>The response from the DescribeSeverityLevels service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeSeverityLevels(Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSeverityLevels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSeverityLevels operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSeverityLevels.</param> <returns>Returns a DescribeSeverityLevelsResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest)"> <summary> Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckRefreshStatuses(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckRefreshStatuses.</param> <returns>Returns a DescribeTrustedAdvisorCheckRefreshStatusesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest)"> <summary> Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <para> In addition, the response contains these fields: </para> <ul> <li> <b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckResult(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckResult.</param> <returns>Returns a DescribeTrustedAdvisorCheckResultResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest)"> <summary> Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method.</param> <returns>The response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorChecks(Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorChecks.</param> <returns>Returns a DescribeTrustedAdvisorChecksResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.DescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest)"> <summary> Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method.</param> <returns>The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginDescribeTrustedAdvisorCheckSummaries(Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrustedAdvisorCheckSummaries.</param> <returns>Returns a DescribeTrustedAdvisorCheckSummariesResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.RefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest)"> <summary> Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para> <ul> <li> <b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method.</param> <returns>The response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginRefreshTrustedAdvisorCheck(Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. </summary> <param name="request">Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRefreshTrustedAdvisorCheck.</param> <returns>Returns a RefreshTrustedAdvisorCheckResult from AWSSupport.</returns> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.ResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest)"> <summary> Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase service method.</param> <returns>The response from the ResolveCase service method, as returned by AWSSupport.</returns> <exception cref="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> The requested <code>CaseId</code> could not be located. </exception> <exception cref="T:Amazon.AWSSupport.Model.InternalServerErrorException"> An internal server error occurred. </exception> </member> <member name="M:Amazon.AWSSupport.AmazonAWSSupportClient.BeginResolveCase(Amazon.AWSSupport.Model.ResolveCaseRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResolveCase operation. </summary> <param name="request">Container for the necessary parameters to execute the ResolveCase operation on AmazonAWSSupportClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResolveCase.</param> <returns>Returns a ResolveCaseResult from AWSSupport.</returns> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupportConfig"> <summary> Configuration for accessing Amazon AWSSupport 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.AddAttachmentsToSetRequest"> <summary> Container for the parameters to the AddAttachmentsToSet operation. Adds one or more attachments to an attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. <para> An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the <code>ExpiryTime</code> returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB. </para> </summary> </member> <member name="T:Amazon.AWSSupport.AmazonAWSSupportRequest"> <summary> Base class for AWSSupport operation requests. </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddAttachmentsToSetRequest.Attachments"> <summary> Gets and sets the property Attachments. <para> One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddAttachmentsToSetRequest.AttachmentSetId"> <summary> Gets and sets the property AttachmentSetId. <para> The ID of the attachment set. If an <code>AttachmentSetId</code> is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> is specified, the attachments are added to the specified set, if it exists. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddAttachmentsToSetResponse"> <summary> Configuration for accessing Amazon AddAttachmentsToSet service </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddAttachmentsToSetResult"> <summary> The ID and expiry time of the attachment set returned by the <a>AddAttachmentsToSet</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddAttachmentsToSetResult.AttachmentSetId"> <summary> Gets and sets the property AttachmentSetId. <para> The ID of the attachment set. If an <code>AttachmentSetId</code> was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an <code>AttachmentSetId</code> was specified, the attachments are added to the specified set, if it exists. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddAttachmentsToSetResult.ExpiryTime"> <summary> Gets and sets the property ExpiryTime. <para> The time and date when the attachment set expires. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddAttachmentsToSetResponse.AddAttachmentsToSetResult"> <summary> Gets and sets the AddAttachmentsToSetResult property. Represents the output of a AddAttachmentsToSet operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest"> <summary> Container for the parameters to the AddCommunicationToCase operation. Adds additional customer communication to an AWS Support case. You use the <code>CaseId</code> value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the <code>CcEmailAddresses</code> value. The <code>CommunicationBody</code> value contains the text of the communication. <para> The response indicates the success or failure of the request. </para> <para> This operation implements a subset of the features of the AWS Support Center. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.AttachmentSetId"> <summary> Gets and sets the property AttachmentSetId. <para> The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling <a>AddAttachmentsToSet</a> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CcEmailAddresses"> <summary> Gets and sets the property CcEmailAddresses. <para> The email addresses in the CC line of an email to be added to the support case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseRequest.CommunicationBody"> <summary> Gets and sets the property CommunicationBody. <para> The body of an email communication to add to the support case. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseResponse"> <summary> Configuration for accessing Amazon AddCommunicationToCase service </summary> </member> <member name="T:Amazon.AWSSupport.Model.AddCommunicationToCaseResult"> <summary> The result of the <a>AddCommunicationToCase</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseResult.Result"> <summary> Gets and sets the property Result. <para> True if <a>AddCommunicationToCase</a> succeeds. Otherwise, returns an error. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AddCommunicationToCaseResponse.AddCommunicationToCaseResult"> <summary> Gets and sets the AddCommunicationToCaseResult property. Represents the output of a AddCommunicationToCase operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.Attachment"> <summary> An attachment to a case communication. The attachment consists of the file name and the content of the file. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Attachment.Data"> <summary> Gets and sets the property Data. <para> The content of the attachment file. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Attachment.FileName"> <summary> Gets and sets the property FileName. <para> The name of the attachment file. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentDetails"> <summary> The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the <a>DescribeAttachment</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.AttachmentDetails.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the attachment. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.AttachmentDetails.FileName"> <summary> Gets and sets the property FileName. <para> The file name of the attachment. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentIdNotFoundException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.AttachmentIdNotFoundException.#ctor(System.String)"> <summary> Constructs a new AttachmentIdNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentLimitExceededException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.AttachmentLimitExceededException.#ctor(System.String)"> <summary> Constructs a new AttachmentLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentSetExpiredException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.AttachmentSetExpiredException.#ctor(System.String)"> <summary> Constructs a new AttachmentSetExpiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.AttachmentSetIdNotFoundException.#ctor(System.String)"> <summary> Constructs a new AttachmentSetIdNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.AttachmentSetSizeLimitExceededException.#ctor(System.String)"> <summary> Constructs a new AttachmentSetSizeLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.CaseCreationLimitExceededException"> <summary> AWSSupport 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> A JSON-formatted object that contains the metadata for a support case. It is contained the response from a <a>DescribeCases</a> request. <b>CaseDetails</b> contains the following fields: <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 <a>DescribeServices</a>.</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 <a>Communication</a> objects. Fields of these objects are <code>Attachments</code>, <code>Body</code>, <code>CaseId</code>, <code>SubmittedBy</code>, and <code>TimeCreated</code>.</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 <a>DescribeServices</a>.</li> <li> <b>SeverityCode. </b>The severity code assigned to the case. Contains one of the values returned by the call to <a>DescribeSeverityLevels</a>.</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="P:Amazon.AWSSupport.Model.CaseDetails.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.CategoryCode"> <summary> Gets and sets the property CategoryCode. <para> The category of problem for the AWS Support case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.CcEmailAddresses"> <summary> Gets and sets the property CcEmailAddresses. <para> The email addresses that receive copies of communication about the case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.DisplayId"> <summary> Gets and sets the property DisplayId. <para> The ID displayed for the case in the AWS Support Center. This is a numeric string. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.RecentCommunications"> <summary> Gets and sets the property RecentCommunications. <para> The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a <code>nextToken</code> that you can use to retrieve earlier communications. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.ServiceCode"> <summary> Gets and sets the property ServiceCode. <para> The code for the AWS service returned by the call to <a>DescribeServices</a>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.SeverityCode"> <summary> Gets and sets the property SeverityCode. <para> The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Status"> <summary> Gets and sets the property Status. <para> The status of the case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.Subject"> <summary> Gets and sets the property Subject. <para> The subject line for the case in the AWS Support Center. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.SubmittedBy"> <summary> Gets and sets the property SubmittedBy. <para> The email address of the account that submitted the case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CaseDetails.TimeCreated"> <summary> Gets and sets the property TimeCreated. <para> The time that the case was case created in the AWS Support Center. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.CaseIdNotFoundException"> <summary> AWSSupport 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> A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the <a>DescribeServices</a> response for each AWS service. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Category.Code"> <summary> Gets and sets the property Code. <para> The category code for the support case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Category.Name"> <summary> Gets and sets the property Name. <para> The category name for the support case. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.Communication"> <summary> A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.AttachmentSet"> <summary> Gets and sets the property AttachmentSet. <para> Information about the attachments to the case communication. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.Body"> <summary> Gets and sets the property Body. <para> The text of the communication between the customer and AWS Support. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.SubmittedBy"> <summary> Gets and sets the property SubmittedBy. <para> The email address of the account that submitted the AWS Support case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Communication.TimeCreated"> <summary> Gets and sets the property TimeCreated. <para> The time the communication was created. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseRequest"> <summary> Container for the parameters to the CreateCase operation. Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. Its parameters require you to specify the following information: <ol> <li> <b>IssueType.</b> The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical." </li> <li> <b>ServiceCode.</b> The code for an AWS service. You obtain the <code>ServiceCode</code> by calling <a>DescribeServices</a>. </li> <li> <b>CategoryCode.</b> The category for the service defined for the <code>ServiceCode</code> value. You also obtain the category code for a service by calling <a>DescribeServices</a>. Each AWS service defines its own set of category codes. </li> <li> <b>SeverityCode.</b> A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling <a>DescribeSeverityLevels</a>.</li> <li> <b>Subject.</b> The <b>Subject</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>CommunicationBody.</b> The <b>Description</b> field on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page.</li> <li> <b>AttachmentSetId.</b> The ID of a set of attachments that has been created by using <a>AddAttachmentsToSet</a>.</li> <li> <b>Language.</b> The human language in which AWS Support handles the case. English and Japanese are currently supported.</li> <li> <b>CcEmailAddresses.</b> The AWS Support Center <b>CC</b> field on the <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an <a href="http://aws.amazon.com/tools/">AWS SDK</a>. </li> </ol> <note> <para> To add additional communication or attachments to an existing case, use <a>AddCommunicationToCase</a>. </para> </note> <para> A successful <a>CreateCase</a> request returns an AWS Support case number. Case numbers are used by the <a>DescribeCases</a> operation to retrieve existing AWS Support cases. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.AttachmentSetId"> <summary> Gets and sets the property AttachmentSetId. <para> The ID of a set of one or more attachments for the case. Create the set by using <a>AddAttachmentsToSet</a>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CategoryCode"> <summary> Gets and sets the property CategoryCode. <para> The category of problem for the AWS Support case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CcEmailAddresses"> <summary> Gets and sets the property CcEmailAddresses. <para> A list of email addresses that AWS Support copies on case correspondence. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.CommunicationBody"> <summary> Gets and sets the property CommunicationBody. <para> The communication body text when you create an AWS Support case by calling <a>CreateCase</a>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.IssueType"> <summary> Gets and sets the property IssueType. <para> 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." </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.ServiceCode"> <summary> Gets and sets the property ServiceCode. <para> The code for the AWS service returned by the call to <a>DescribeServices</a>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.SeverityCode"> <summary> Gets and sets the property SeverityCode. <para> The code for the severity level returned by the call to <a>DescribeSeverityLevels</a>. </para> <note> <para> 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. </para> </note> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseRequest.Subject"> <summary> Gets and sets the property Subject. <para> The title of the AWS Support case. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseResponse"> <summary> Configuration for accessing Amazon CreateCase service </summary> </member> <member name="T:Amazon.AWSSupport.Model.CreateCaseResult"> <summary> The AWS Support case ID returned by a successful completion of the <a>CreateCase</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseResult.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.CreateCaseResponse.CreateCaseResult"> <summary> Gets and sets the CreateCaseResult property. Represents the output of a CreateCase operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException"> <summary> AWSSupport exception </summary> </member> <member name="M:Amazon.AWSSupport.Model.DescribeAttachmentLimitExceededException.#ctor(System.String)"> <summary> Constructs a new DescribeAttachmentLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.AWSSupport.Model.DescribeAttachmentRequest"> <summary> Container for the parameters to the DescribeAttachment operation. Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the <a>AttachmentDetails</a> objects that are returned by the <a>DescribeCommunications</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeAttachmentRequest.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the attachment to return. Attachment IDs are returned by the <a>DescribeCommunications</a> operation. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeAttachmentResponse"> <summary> Configuration for accessing Amazon DescribeAttachment service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeAttachmentResult"> <summary> The content and file name of the attachment returned by the <a>DescribeAttachment</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeAttachmentResult.Attachment"> <summary> Gets and sets the property Attachment. <para> The attachment content and file name. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeAttachmentResponse.DescribeAttachmentResult"> <summary> Gets and sets the DescribeAttachmentResult property. Represents the output of a DescribeAttachment operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesRequest"> <summary> Container for the parameters to the DescribeCases operation. Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the <code>AfterTime</code> and <code>BeforeTime</code> request parameters. You can set values for the <code>IncludeResolvedCases</code> and <code>IncludeCommunications</code> request parameters to control how much information is returned. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> The response returns the following in JSON format: </para> <ol> <li>One or more <a>CaseDetails</a> data types. </li> <li>One or more <code>NextToken</code> values, which specify where to paginate the returned records represented by the <code>CaseDetails</code> objects.</li> </ol> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.AfterTime"> <summary> Gets and sets the property AfterTime. <para> The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.BeforeTime"> <summary> Gets and sets the property BeforeTime. <para> The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.CaseIdList"> <summary> Gets and sets the property CaseIdList. <para> A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.DisplayId"> <summary> Gets and sets the property DisplayId. <para> The ID displayed for a case in the AWS Support Center user interface. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.IncludeCommunications"> <summary> Gets and sets the property IncludeCommunications. <para> Specifies whether communications should be included in the <a>DescribeCases</a> results. The default is <i>true</i>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.IncludeResolvedCases"> <summary> Gets and sets the property IncludeResolvedCases. <para> Specifies whether resolved support cases should be included in the <a>DescribeCases</a> results. The default is <i>false</i>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return before paginating. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A resumption point for pagination. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesResponse"> <summary> Configuration for accessing Amazon DescribeCases service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCasesResult"> <summary> Returns an array of <a>CaseDetails</a> objects and a <code>NextToken</code> that defines a point for pagination in the result set. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResult.Cases"> <summary> Gets and sets the property Cases. <para> The details for the cases that match the request. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A resumption point for pagination. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCasesResponse.DescribeCasesResult"> <summary> Gets and sets the DescribeCasesResult property. Represents the output of a DescribeCases operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsRequest"> <summary> Container for the parameters to the DescribeCommunications operation. Returns communications (and attachments) for one or more support cases. You can use the <code>AfterTime</code> and <code>BeforeTime</code> parameters to filter by date. You can use the <code>CaseId</code> parameter to restrict the results to a particular case. <para> Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. </para> <para> You can use the <code>MaxResults</code> and <code>NextToken</code> parameters to control the pagination of the result set. Set <code>MaxResults</code> to the number of cases you want displayed on each page, and use <code>NextToken</code> to specify the resumption of pagination. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.AfterTime"> <summary> Gets and sets the property AfterTime. <para> The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.BeforeTime"> <summary> Gets and sets the property BeforeTime. <para> The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return before paginating. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A resumption point for pagination. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsResponse"> <summary> Configuration for accessing Amazon DescribeCommunications service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeCommunicationsResult"> <summary> The communications returned by the <a>DescribeCommunications</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResult.Communications"> <summary> Gets and sets the property Communications. <para> The communications for the case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A resumption point for pagination. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeCommunicationsResponse.DescribeCommunicationsResult"> <summary> Gets and sets the DescribeCommunicationsResult property. Represents the output of a DescribeCommunications operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesRequest"> <summary> Container for the parameters to the DescribeServices operation. Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your <a>CreateCase</a> requests. Each AWS service has its own set of categories. <para> The service codes and category codes correspond to the values that are displayed in the <b>Service</b> and <b>Category</b> drop-down lists on the AWS Support Center <a href="https://console.aws.amazon.com/support/home#/case/create">Create Case</a> page. The values in those fields, however, do not necessarily match the service codes and categories returned by the <code>DescribeServices</code> request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesRequest.ServiceCodeList"> <summary> Gets and sets the property ServiceCodeList. <para> A JSON-formatted list of service codes available for AWS services. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesResponse"> <summary> Configuration for accessing Amazon DescribeServices service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeServicesResult"> <summary> The list of AWS services returned by the <a>DescribeServices</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesResult.Services"> <summary> Gets and sets the property Services. <para> A JSON-formatted list of AWS services. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeServicesResponse.DescribeServicesResult"> <summary> Gets and sets the DescribeServicesResult property. Represents the output of a DescribeServices operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest"> <summary> Container for the parameters to the DescribeSeverityLevels operation. Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the <a>CaseDetails</a> data type included in any <a>CreateCase</a> request. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsResponse"> <summary> Configuration for accessing Amazon DescribeSeverityLevels service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult"> <summary> The list of severity levels returned by the <a>DescribeSeverityLevels</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsResult.SeverityLevels"> <summary> Gets and sets the property SeverityLevels. <para> The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeSeverityLevelsResponse.DescribeSeverityLevelsResult"> <summary> Gets and sets the DescribeSeverityLevelsResult property. Represents the output of a DescribeSeverityLevels operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckRefreshStatuses operation. Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesRequest.CheckIds"> <summary> Gets and sets the property CheckIds. <para> The IDs of the Trusted Advisor checks. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResponse"> <summary> Configuration for accessing Amazon DescribeTrustedAdvisorCheckRefreshStatuses service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult"> <summary> The statuses of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckRefreshStatuses</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResult.Statuses"> <summary> Gets and sets the property Statuses. <para> The refresh status of the specified Trusted Advisor checks. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckRefreshStatusesResponse.DescribeTrustedAdvisorCheckRefreshStatusesResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckRefreshStatusesResult property. Represents the output of a DescribeTrustedAdvisorCheckRefreshStatuses operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckResult operation. Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckResult</a> object, which contains these three objects: </para> <ul> <li><a>TrustedAdvisorCategorySpecificSummary</a></li> <li><a>TrustedAdvisorResourceDetail</a></li> <li><a>TrustedAdvisorResourcesSummary</a></li> </ul> <para> In addition, the response contains these fields: </para> <ul> <li> <b>Status.</b> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".</li> <li> <b>Timestamp.</b> The time of the last refresh of the check.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.CheckId"> <summary> Gets and sets the property CheckId. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResponse"> <summary> Configuration for accessing Amazon DescribeTrustedAdvisorCheckResult service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResult"> <summary> The result of the Trusted Advisor check returned by the <a>DescribeTrustedAdvisorCheckResult</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResult.Result"> <summary> Gets and sets the property Result. <para> The detailed results of the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckResultResponse.DescribeTrustedAdvisorCheckResultResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckResultResult property. Represents the output of a DescribeTrustedAdvisorCheckResult operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorChecks operation. Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a <a>TrustedAdvisorCheckDescription</a> for each check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksRequest.Language"> <summary> Gets and sets the property Language. <para> 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. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResponse"> <summary> Configuration for accessing Amazon DescribeTrustedAdvisorChecks service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult"> <summary> Information about the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorChecks</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResult.Checks"> <summary> Gets and sets the property Checks. <para> Information about all available Trusted Advisor checks. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorChecksResponse.DescribeTrustedAdvisorChecksResult"> <summary> Gets and sets the DescribeTrustedAdvisorChecksResult property. Represents the output of a DescribeTrustedAdvisorChecks operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest"> <summary> Container for the parameters to the DescribeTrustedAdvisorCheckSummaries operation. Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains an array of <a>TrustedAdvisorCheckSummary</a> objects. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesRequest.CheckIds"> <summary> Gets and sets the property CheckIds. <para> The IDs of the Trusted Advisor checks. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResponse"> <summary> Configuration for accessing Amazon DescribeTrustedAdvisorCheckSummaries service </summary> </member> <member name="T:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult"> <summary> The summaries of the Trusted Advisor checks returned by the <a>DescribeTrustedAdvisorCheckSummaries</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResult.Summaries"> <summary> Gets and sets the property Summaries. <para> The summary information for the requested Trusted Advisor checks. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.DescribeTrustedAdvisorCheckSummariesResponse.DescribeTrustedAdvisorCheckSummariesResult"> <summary> Gets and sets the DescribeTrustedAdvisorCheckSummariesResult property. Represents the output of a DescribeTrustedAdvisorCheckSummaries operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.InternalServerErrorException"> <summary> AWSSupport 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.RecentCaseCommunications"> <summary> The five most recent communications associated with the case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.RecentCaseCommunications.Communications"> <summary> Gets and sets the property Communications. <para> The five most recent communications associated with the case. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.RecentCaseCommunications.NextToken"> <summary> Gets and sets the property NextToken. <para> A resumption point for pagination. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest"> <summary> Container for the parameters to the RefreshTrustedAdvisorCheck operation. Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling <a>DescribeTrustedAdvisorChecks</a>. <para> The response contains a <a>TrustedAdvisorCheckRefreshStatus</a> object, which contains these fields: </para> <ul> <li> <b>Status.</b> The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".</li> <li> <b>MillisUntilNextRefreshable.</b> The amount of time, in milliseconds, until the check is eligible for refresh.</li> <li> <b>CheckId.</b> The unique identifier for the check.</li> </ul> </summary> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckRequest.CheckId"> <summary> Gets and sets the property CheckId. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResponse"> <summary> Configuration for accessing Amazon RefreshTrustedAdvisorCheck service </summary> </member> <member name="T:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResult"> <summary> The current refresh status of a Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResult.Status"> <summary> Gets and sets the property Status. <para> The current refresh status for a check, including the amount of time until the check is eligible for refresh. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.RefreshTrustedAdvisorCheckResponse.RefreshTrustedAdvisorCheckResult"> <summary> Gets and sets the RefreshTrustedAdvisorCheckResult property. Represents the output of a RefreshTrustedAdvisorCheck operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseRequest"> <summary> Container for the parameters to the ResolveCase operation. Takes a <code>CaseId</code> and returns the initial state of the case along with the state of the case after the call to <a>ResolveCase</a> completed. </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseRequest.CaseId"> <summary> Gets and sets the property CaseId. <para> 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> </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseResponse"> <summary> Configuration for accessing Amazon ResolveCase service </summary> </member> <member name="T:Amazon.AWSSupport.Model.ResolveCaseResult"> <summary> The status of the case returned by the <a>ResolveCase</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResult.FinalCaseStatus"> <summary> Gets and sets the property FinalCaseStatus. <para> The status of the case after the <a>ResolveCase</a> request was processed. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResult.InitialCaseStatus"> <summary> Gets and sets the property InitialCaseStatus. <para> The status of the case when the <a>ResolveCase</a> request was sent. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.ResolveCaseResponse.ResolveCaseResult"> <summary> Gets and sets the ResolveCaseResult property. Represents the output of a ResolveCase operation. </summary> </member> <member name="T:Amazon.AWSSupport.Model.Service"> <summary> Information about an AWS service returned by the <a>DescribeServices</a> operation. </summary> </member> <member name="P:Amazon.AWSSupport.Model.Service.Categories"> <summary> Gets and sets the property Categories. <para> 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>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Service.Code"> <summary> Gets and sets the property Code. <para> The code for an AWS service returned by the <a>DescribeServices</a> response. The <code>Name</code> element contains the corresponding friendly name. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.Service.Name"> <summary> Gets and sets the property Name. <para> The friendly name for an AWS service. The <code>Code</code> element contains the corresponding code. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.SeverityLevel"> <summary> A code and name pair that represent a severity level that can be applied to a support case. </summary> </member> <member name="P:Amazon.AWSSupport.Model.SeverityLevel.Code"> <summary> Gets and sets the property Code. <para> One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in <code>SeverityLevel.name</code>. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.SeverityLevel.Name"> <summary> Gets and sets the property Name. <para> The name of the severity level that corresponds to the severity level code. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary"> <summary> The container for summary information that relates to the category of the Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCategorySpecificSummary.CostOptimizing"> <summary> Gets and sets the property CostOptimizing. <para> The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription"> <summary> The description and metadata for a Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Category"> <summary> Gets and sets the property Category. <para> The category of the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Description"> <summary> Gets and sets the property Description. <para> The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup). </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Id"> <summary> Gets and sets the property Id. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Metadata"> <summary> Gets and sets the property Metadata. <para> 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. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckDescription.Name"> <summary> Gets and sets the property Name. <para> The display name for the Trusted Advisor check. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus"> <summary> The refresh status of a Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.CheckId"> <summary> Gets and sets the property CheckId. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.MillisUntilNextRefreshable"> <summary> Gets and sets the property MillisUntilNextRefreshable. <para> The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckRefreshStatus.Status"> <summary> Gets and sets the property Status. <para> The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned". </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult"> <summary> The results of a Trusted Advisor check returned by <a>DescribeTrustedAdvisorCheckResult</a>. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.CategorySpecificSummary"> <summary> Gets and sets the property CategorySpecificSummary. <para> Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.CheckId"> <summary> Gets and sets the property CheckId. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.FlaggedResources"> <summary> Gets and sets the property FlaggedResources. <para> The details about each resource listed in the check result. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.ResourcesSummary"> <summary> Gets and sets the property ResourcesSummary. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.Status"> <summary> Gets and sets the property Status. <para> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckResult.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time of the last refresh of the check. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary"> <summary> A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.CategorySpecificSummary"> <summary> Gets and sets the property CategorySpecificSummary. <para> Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.CheckId"> <summary> Gets and sets the property CheckId. <para> The unique identifier for the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.HasFlaggedResources"> <summary> Gets and sets the property HasFlaggedResources. <para> Specifies whether the Trusted Advisor check has flagged resources. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.ResourcesSummary"> <summary> Gets and sets the property ResourcesSummary. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.Status"> <summary> Gets and sets the property Status. <para> The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available". </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCheckSummary.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time of the last refresh of the check. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary"> <summary> The estimated cost savings that might be realized if the recommended actions are taken. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.EstimatedMonthlySavings"> <summary> Gets and sets the property EstimatedMonthlySavings. <para> The estimated monthly savings that might be realized if the recommended actions are taken. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorCostOptimizingSummary.EstimatedPercentMonthlySavings"> <summary> Gets and sets the property EstimatedPercentMonthlySavings. <para> The estimated percentage of savings that might be realized if the recommended actions are taken. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail"> <summary> Contains information about a resource identified by a Trusted Advisor check. </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.IsSuppressed"> <summary> Gets and sets the property IsSuppressed. <para> Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Metadata"> <summary> Gets and sets the property Metadata. <para> 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>. <b>Metadata</b> contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Region"> <summary> Gets and sets the property Region. <para> The AWS region in which the identified resource is located. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The unique identifier for the identified resource. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourceDetail.Status"> <summary> Gets and sets the property Status. <para> The status code for the resource identified in the Trusted Advisor check. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary"> <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.TrustedAdvisorResourcesSummary.ResourcesFlagged"> <summary> Gets and sets the property ResourcesFlagged. <para> The number of AWS resources that were flagged (listed) by the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesIgnored"> <summary> Gets and sets the property ResourcesIgnored. <para> The number of AWS resources ignored by Trusted Advisor because information was unavailable. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesProcessed"> <summary> Gets and sets the property ResourcesProcessed. <para> The number of AWS resources that were analyzed by the Trusted Advisor check. </para> </summary> </member> <member name="P:Amazon.AWSSupport.Model.TrustedAdvisorResourcesSummary.ResourcesSuppressed"> <summary> Gets and sets the property ResourcesSuppressed. <para> The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user. </para> </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AddAttachmentsToSetRequestMarshaller"> <summary> AddAttachmentsToSet Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AddAttachmentsToSetResponseUnmarshaller"> <summary> Response Unmarshaller for AddAttachmentsToSet 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.AddCommunicationToCaseRequestMarshaller"> <summary> AddCommunicationToCase 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.AWSSupport.Model.Internal.MarshallTransformations.AttachmentDetailsUnmarshaller"> <summary> Response Unmarshaller for AttachmentDetails Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AttachmentMarshaller"> <summary> Attachment Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.AttachmentUnmarshaller"> <summary> Response Unmarshaller for Attachment Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CaseDetailsUnmarshaller"> <summary> Response Unmarshaller for CaseDetails Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CategoryUnmarshaller"> <summary> Response Unmarshaller for Category Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CommunicationUnmarshaller"> <summary> Response Unmarshaller for Communication Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.CreateCaseRequestMarshaller"> <summary> CreateCase 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.DescribeAttachmentRequestMarshaller"> <summary> DescribeAttachment Request Marshaller </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeAttachmentResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAttachment operation </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.DescribeCasesRequestMarshaller"> <summary> DescribeCases 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.DescribeCommunicationsRequestMarshaller"> <summary> DescribeCommunications 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.DescribeServicesRequestMarshaller"> <summary> DescribeServices 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.DescribeSeverityLevelsRequestMarshaller"> <summary> DescribeSeverityLevels 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.DescribeTrustedAdvisorCheckRefreshStatusesRequestMarshaller"> <summary> DescribeTrustedAdvisorCheckRefreshStatuses 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.DescribeTrustedAdvisorCheckResultRequestMarshaller"> <summary> DescribeTrustedAdvisorCheckResult 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.DescribeTrustedAdvisorChecksRequestMarshaller"> <summary> DescribeTrustedAdvisorChecks 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.DescribeTrustedAdvisorCheckSummariesRequestMarshaller"> <summary> DescribeTrustedAdvisorCheckSummaries 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.RecentCaseCommunicationsUnmarshaller"> <summary> Response Unmarshaller for RecentCaseCommunications Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.RefreshTrustedAdvisorCheckRequestMarshaller"> <summary> RefreshTrustedAdvisorCheck 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.ResolveCaseRequestMarshaller"> <summary> ResolveCase 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.ServiceUnmarshaller"> <summary> Response Unmarshaller for Service Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.SeverityLevelUnmarshaller"> <summary> Response Unmarshaller for SeverityLevel Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCategorySpecificSummaryUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCategorySpecificSummary Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckDescriptionUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCheckDescription Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckRefreshStatusUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCheckRefreshStatus Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckResultUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCheckResult Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCheckSummaryUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCheckSummary Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorCostOptimizingSummaryUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorCostOptimizingSummary Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorResourceDetailUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorResourceDetail Object </summary> </member> <member name="T:Amazon.AWSSupport.Model.Internal.MarshallTransformations.TrustedAdvisorResourcesSummaryUnmarshaller"> <summary> Response Unmarshaller for TrustedAdvisorResourcesSummary Object </summary> </member> <member name="T:Amazon.CodeDeploy.AmazonCodeDeployClient"> <summary> Implementation for accessing CodeDeploy AWS CodeDeploy <b>Overview</b> <para> This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the <a href="http://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy User Guide</a>. </para> <b>Using the APIs</b> <para> You can use the AWS CodeDeploy APIs to work with the following items: </para> <ul> <li> <para> Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications. </para> </li> <li> <para> Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations. </para> </li> <li> <para> Deployment groups are groups of instances to which application revisions can be deployed. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups. </para> </li> <li> <para> Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get and list instances. </para> </li> <li> <para> Deployments represent the process of deploying revisions to instances. </para> <para> You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments. </para> </li> <li> <para> Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get, list, and register application revisions. </para> </li> </ul> </summary> </member> <member name="T:Amazon.CodeDeploy.IAmazonCodeDeploy"> <summary> Interface for accessing CodeDeploy AWS CodeDeploy <b>Overview</b> <para> This is the AWS CodeDeploy API Reference. This guide provides descriptions of the AWS CodeDeploy APIs. For additional information, see the <a href="http://docs.aws.amazon.com/codedeploy/latest/userguide">AWS CodeDeploy User Guide</a>. </para> <b>Using the APIs</b> <para> You can use the AWS CodeDeploy APIs to work with the following items: </para> <ul> <li> <para> Applications are unique identifiers that AWS CodeDeploy uses to ensure that the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications. </para> </li> <li> <para> Deployment configurations are sets of deployment rules and deployment success and failure conditions that AWS CodeDeploy uses during deployments. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations. </para> </li> <li> <para> Deployment groups are groups of instances to which application revisions can be deployed. </para> <para> You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups. </para> </li> <li> <para> Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get and list instances. </para> </li> <li> <para> Deployments represent the process of deploying revisions to instances. </para> <para> You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments. </para> </li> <li> <para> Application revisions are archive files that are stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, any deployment scripts, and similar) along with an Application Specification file (AppSpec file). (The AppSpec file is unique to AWS CodeDeploy; it defines a series of deployment actions that you want AWS CodeDeploy to execute.) An application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both (for application revisions that are stored in Amazon S3 buckets) or by its repository name and commit ID (for applications revisions that are stored in GitHub repositories). Application revisions are deployed through deployment groups. </para> <para> You can use the AWS CodeDeploy APIs to get, list, and register application revisions. </para> </li> </ul> </summary> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.AddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest)"> <summary> Adds tags to on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances service method.</param> <returns>The response from the AddTagsToOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginAddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddTagsToOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndAddTagsToOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTagsToOnPremisesInstances.</param> <returns>Returns a AddTagsToOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest)"> <summary> Gets information about one or more application revisions. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions service method.</param> <returns>The response from the BatchGetApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginBatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetApplicationRevisions operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndBatchGetApplicationRevisions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetApplicationRevisions.</param> <returns>Returns a BatchGetApplicationRevisionsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest)"> <summary> Gets information about one or more applications. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications service method.</param> <returns>The response from the BatchGetApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginBatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetApplications operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndBatchGetApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetApplications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetApplications.</param> <returns>Returns a BatchGetApplicationsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest)"> <summary> Gets information about one or more instances that are part of a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances service method.</param> <returns>The response from the BatchGetDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginBatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetDeploymentInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndBatchGetDeploymentInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetDeploymentInstances.</param> <returns>Returns a BatchGetDeploymentInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest)"> <summary> Gets information about one or more deployments. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments service method.</param> <returns>The response from the BatchGetDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginBatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetDeployments operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndBatchGetDeployments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetDeployments.</param> <returns>Returns a BatchGetDeploymentsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest)"> <summary> Gets information about one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances service method.</param> <returns>The response from the BatchGetOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginBatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndBatchGetOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetOnPremisesInstances.</param> <returns>Returns a BatchGetOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest)"> <summary> Creates a new application. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationLimitExceededException"> More applications were attempted to be created than were allowed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginCreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.IAmazonCodeDeploy.EndCreateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplication.</param> <returns>Returns a CreateApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest)"> <summary> Deploys an application revision through the specified deployment group. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentLimitExceededException"> The number of allowed deployments was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginCreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndCreateDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeployment.</param> <returns>Returns a CreateDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest)"> <summary> Creates a new deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig service method.</param> <returns>The response from the CreateDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException"> A deployment configuration with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException"> The deployment configurations limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException"> The minimum healthy instances value was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginCreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndCreateDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeploymentConfig.</param> <returns>Returns a CreateDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.CreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest)"> <summary> Creates a new deployment group for application revisions to be deployed to. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup service method.</param> <returns>The response from the CreateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException"> The deployment groups limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RoleRequiredException"> The role ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginCreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndCreateDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeploymentGroup.</param> <returns>Returns a CreateDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest)"> <summary> Deletes an application. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginDeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.IAmazonCodeDeploy.EndDeleteApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplication.</param> <returns>Returns a DeleteApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest)"> <summary> Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig service method.</param> <returns>The response from the DeleteDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigInUseException"> The deployment configuration is still in use. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidOperationException"> An invalid operation was detected. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginDeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndDeleteDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeploymentConfig.</param> <returns>Returns a DeleteDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest)"> <summary> Deletes a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup service method.</param> <returns>The response from the DeleteDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginDeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndDeleteDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeploymentGroup.</param> <returns>Returns a DeleteDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.DeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest)"> <summary> Deregisters an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance service method.</param> <returns>The response from the DeregisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginDeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndDeregisterOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterOnPremisesInstance.</param> <returns>Returns a DeregisterOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest)"> <summary> Gets information about an application. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication service method.</param> <returns>The response from the GetApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetApplication operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetApplication.</param> <returns>Returns a GetApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest)"> <summary> Gets information about an application revision. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision service method.</param> <returns>The response from the GetApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionDoesNotExistException"> The named revision does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetApplicationRevision operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetApplicationRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetApplicationRevision.</param> <returns>Returns a GetApplicationRevisionResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest)"> <summary> Gets information about a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment service method.</param> <returns>The response from the GetDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeployment.</param> <returns>Returns a GetDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest)"> <summary> Gets information about a deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig service method.</param> <returns>The response from the GetDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentConfig.</param> <returns>Returns a GetDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest)"> <summary> Gets information about a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup service method.</param> <returns>The response from the GetDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentGroup.</param> <returns>Returns a GetDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest)"> <summary> Gets information about an instance as part of a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance service method.</param> <returns>The response from the GetDeploymentInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceDoesNotExistException"> The specified instance does not exist in the deployment group. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetDeploymentInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentInstance.</param> <returns>Returns a GetDeploymentInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.GetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest)"> <summary> Gets information about an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance service method.</param> <returns>The response from the GetOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginGetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndGetOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOnPremisesInstance.</param> <returns>Returns a GetOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest)"> <summary> Lists information about revisions for an application. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions service method.</param> <returns>The response from the ListApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException"> A bucket name is required but was not provided. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException"> The bucket name either doesn't exist or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException"> The deployed state filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException"> The specified key prefix filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortByException"> The column name to sort by is either not present or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortOrderException"> The sort order was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApplicationRevisions operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListApplicationRevisions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListApplicationRevisions.</param> <returns>Returns a ListApplicationRevisionsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplications"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest)"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications service method.</param> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApplications operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListApplications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListApplications.</param> <returns>Returns a ListApplicationsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentConfigs"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest)"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs service method.</param> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentConfigs operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListDeploymentConfigs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentConfigs.</param> <returns>Returns a ListDeploymentConfigsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest)"> <summary> Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups service method.</param> <returns>The response from the ListDeploymentGroups service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentGroups operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListDeploymentGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentGroups.</param> <returns>Returns a ListDeploymentGroupsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest)"> <summary> Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances service method.</param> <returns>The response from the ListDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentNotStartedException"> The specified deployment has not started. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceStatusException"> The specified instance status does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListDeploymentInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentInstances.</param> <returns>Returns a ListDeploymentInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest)"> <summary> Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments service method.</param> <returns>The response from the ListDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException"> The specified deployment status doesn't exist or cannot be determined. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTimeRangeException"> The specified time range was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeployments operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListDeployments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeployments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeployments.</param> <returns>Returns a ListDeploymentsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.ListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest)"> <summary> Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances service method.</param> <returns>The response from the ListOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException"> The registration status was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagFilterException"> The specified tag filter was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndListOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListOnPremisesInstances.</param> <returns>Returns a ListOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest)"> <summary> Registers with AWS CodeDeploy a revision for the specified application. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision service method.</param> <returns>The response from the RegisterApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginRegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterApplicationRevision operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndRegisterApplicationRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterApplicationRevision.</param> <returns>Returns a RegisterApplicationRevisionResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest)"> <summary> Registers an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance service method.</param> <returns>The response from the RegisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException"> The specified IAM user ARN is already registered with an on-premises instance. </exception> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnRequiredException"> An IAM user ARN was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException"> The specified on-premises instance name is already registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidIamUserArnException"> The IAM user ARN was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginRegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndRegisterOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterOnPremisesInstance.</param> <returns>Returns a RegisterOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.RemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest)"> <summary> Removes one or more tags from one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances service method.</param> <returns>The response from the RemoveTagsFromOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginRemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveTagsFromOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndRemoveTagsFromOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTagsFromOnPremisesInstances.</param> <returns>Returns a RemoveTagsFromOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.StopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest)"> <summary> Attempts to stop an ongoing deployment. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment service method.</param> <returns>The response from the StopDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException"> The deployment is already completed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginStopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndStopDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopDeployment.</param> <returns>Returns a StopDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest)"> <summary> Changes an existing application's name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginUpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.IAmazonCodeDeploy.EndUpdateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplication.</param> <returns>Returns a UpdateApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.UpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest)"> <summary> Changes information about an existing deployment group. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup service method.</param> <returns>The response from the UpdateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.BeginUpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.IAmazonCodeDeploy.EndUpdateDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDeploymentGroup.</param> <returns>Returns a UpdateDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Credentials and an AmazonCodeDeployClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.#ctor(System.String,System.String,System.String,Amazon.CodeDeploy.AmazonCodeDeployConfig)"> <summary> Constructs AmazonCodeDeployClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeDeployClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodeDeployClient Configuration Object</param> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.AddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest)"> <summary> Adds tags to on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances service method.</param> <returns>The response from the AddTagsToOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginAddTagsToOnPremisesInstances(Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTagsToOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAddTagsToOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndAddTagsToOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTagsToOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTagsToOnPremisesInstances.</param> <returns>Returns a AddTagsToOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest)"> <summary> Gets information about one or more application revisions. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions service method.</param> <returns>The response from the BatchGetApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginBatchGetApplicationRevisions(Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplicationRevisions operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetApplicationRevisions operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndBatchGetApplicationRevisions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetApplicationRevisions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetApplicationRevisions.</param> <returns>Returns a BatchGetApplicationRevisionsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest)"> <summary> Gets information about one or more applications. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications service method.</param> <returns>The response from the BatchGetApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginBatchGetApplications(Amazon.CodeDeploy.Model.BatchGetApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetApplications operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetApplications operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndBatchGetApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetApplications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetApplications.</param> <returns>Returns a BatchGetApplicationsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest)"> <summary> Gets information about one or more instances that are part of a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances service method.</param> <returns>The response from the BatchGetDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginBatchGetDeploymentInstances(Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeploymentInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetDeploymentInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndBatchGetDeploymentInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetDeploymentInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetDeploymentInstances.</param> <returns>Returns a BatchGetDeploymentInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest)"> <summary> Gets information about one or more deployments. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments service method.</param> <returns>The response from the BatchGetDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginBatchGetDeployments(Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetDeployments operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetDeployments operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndBatchGetDeployments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetDeployments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetDeployments.</param> <returns>Returns a BatchGetDeploymentsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest)"> <summary> Gets information about one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances service method.</param> <returns>The response from the BatchGetOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> The maximum number of names or IDs allowed for this request (100) was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginBatchGetOnPremisesInstances(Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndBatchGetOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetOnPremisesInstances.</param> <returns>Returns a BatchGetOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest)"> <summary> Creates a new application. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication service method.</param> <returns>The response from the CreateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationLimitExceededException"> More applications were attempted to be created than were allowed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginCreateApplication(Amazon.CodeDeploy.Model.CreateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.AmazonCodeDeployClient.EndCreateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateApplication.</param> <returns>Returns a CreateApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest)"> <summary> Deploys an application revision through the specified deployment group. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment service method.</param> <returns>The response from the CreateDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentLimitExceededException"> The number of allowed deployments was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginCreateDeployment(Amazon.CodeDeploy.Model.CreateDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndCreateDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeployment.</param> <returns>Returns a CreateDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest)"> <summary> Creates a new deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig service method.</param> <returns>The response from the CreateDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException"> A deployment configuration with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException"> The deployment configurations limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException"> The minimum healthy instances value was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginCreateDeploymentConfig(Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndCreateDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeploymentConfig.</param> <returns>Returns a CreateDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.CreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest)"> <summary> Creates a new deployment group for application revisions to be deployed to. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup service method.</param> <returns>The response from the CreateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException"> The deployment groups limit was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RoleRequiredException"> The role ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginCreateDeploymentGroup(Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndCreateDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDeploymentGroup.</param> <returns>Returns a CreateDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest)"> <summary> Deletes an application. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication service method.</param> <returns>The response from the DeleteApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginDeleteApplication(Amazon.CodeDeploy.Model.DeleteApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.AmazonCodeDeployClient.EndDeleteApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteApplication.</param> <returns>Returns a DeleteApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest)"> <summary> Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig service method.</param> <returns>The response from the DeleteDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigInUseException"> The deployment configuration is still in use. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidOperationException"> An invalid operation was detected. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginDeleteDeploymentConfig(Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndDeleteDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeploymentConfig.</param> <returns>Returns a DeleteDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest)"> <summary> Deletes a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup service method.</param> <returns>The response from the DeleteDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginDeleteDeploymentGroup(Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndDeleteDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeploymentGroup.</param> <returns>Returns a DeleteDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.DeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest)"> <summary> Deregisters an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance service method.</param> <returns>The response from the DeregisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginDeregisterOnPremisesInstance(Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndDeregisterOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterOnPremisesInstance.</param> <returns>Returns a DeregisterOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest)"> <summary> Gets information about an application. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication service method.</param> <returns>The response from the GetApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetApplication(Amazon.CodeDeploy.Model.GetApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetApplication operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetApplication.</param> <returns>Returns a GetApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest)"> <summary> Gets information about an application revision. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision service method.</param> <returns>The response from the GetApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionDoesNotExistException"> The named revision does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetApplicationRevision(Amazon.CodeDeploy.Model.GetApplicationRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the GetApplicationRevision operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetApplicationRevision operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetApplicationRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetApplicationRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetApplicationRevision.</param> <returns>Returns a GetApplicationRevisionResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest)"> <summary> Gets information about a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment service method.</param> <returns>The response from the GetDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetDeployment(Amazon.CodeDeploy.Model.GetDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeployment.</param> <returns>Returns a GetDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest)"> <summary> Gets information about a deployment configuration. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig service method.</param> <returns>The response from the GetDeploymentConfig service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> The deployment configuration name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetDeploymentConfig(Amazon.CodeDeploy.Model.GetDeploymentConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentConfig operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentConfig operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetDeploymentConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentConfig.</param> <returns>Returns a GetDeploymentConfigResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest)"> <summary> Gets information about a deployment group. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup service method.</param> <returns>The response from the GetDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetDeploymentGroup(Amazon.CodeDeploy.Model.GetDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentGroup.</param> <returns>Returns a GetDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest)"> <summary> Gets information about an instance as part of a deployment. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance service method.</param> <returns>The response from the GetDeploymentInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceDoesNotExistException"> The specified instance does not exist in the deployment group. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> The instance ID was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetDeploymentInstance(Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDeploymentInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDeploymentInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetDeploymentInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDeploymentInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDeploymentInstance.</param> <returns>Returns a GetDeploymentInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.GetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest)"> <summary> Gets information about an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance service method.</param> <returns>The response from the GetOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginGetOnPremisesInstance(Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndGetOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOnPremisesInstance.</param> <returns>Returns a GetOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest)"> <summary> Lists information about revisions for an application. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions service method.</param> <returns>The response from the ListApplicationRevisions service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException"> A bucket name is required but was not provided. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException"> The bucket name either doesn't exist or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException"> The deployed state filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException"> The specified key prefix filter was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortByException"> The column name to sort by is either not present or was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidSortOrderException"> The sort order was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListApplicationRevisions(Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplicationRevisions operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApplicationRevisions operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListApplicationRevisions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListApplicationRevisions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListApplicationRevisions.</param> <returns>Returns a ListApplicationRevisionsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplications"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest)"> <summary> Lists the applications registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications service method.</param> <returns>The response from the ListApplications service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListApplications(Amazon.CodeDeploy.Model.ListApplicationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListApplications operation. </summary> <param name="request">Container for the necessary parameters to execute the ListApplications operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListApplications operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListApplications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListApplications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListApplications.</param> <returns>Returns a ListApplicationsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentConfigs"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest)"> <summary> Lists the deployment configurations with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs service method.</param> <returns>The response from the ListDeploymentConfigs service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListDeploymentConfigs(Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentConfigs operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentConfigs operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListDeploymentConfigs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentConfigs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentConfigs.</param> <returns>Returns a ListDeploymentConfigsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest)"> <summary> Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups service method.</param> <returns>The response from the ListDeploymentGroups service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListDeploymentGroups(Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentGroups operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentGroups operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListDeploymentGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentGroups.</param> <returns>Returns a ListDeploymentGroupsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest)"> <summary> Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances service method.</param> <returns>The response from the ListDeploymentInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentNotStartedException"> The specified deployment has not started. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceStatusException"> The specified instance status does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListDeploymentInstances(Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeploymentInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeploymentInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListDeploymentInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeploymentInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeploymentInstances.</param> <returns>Returns a ListDeploymentInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest)"> <summary> Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments service method.</param> <returns>The response from the ListDeployments service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException"> The specified deployment status doesn't exist or cannot be determined. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTimeRangeException"> The specified time range was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListDeployments(Amazon.CodeDeploy.Model.ListDeploymentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDeployments operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDeployments operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDeployments operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListDeployments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDeployments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDeployments.</param> <returns>Returns a ListDeploymentsResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.ListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest)"> <summary> Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances service method.</param> <returns>The response from the ListOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> The next token was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException"> The registration status was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagFilterException"> The specified tag filter was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginListOnPremisesInstances(Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndListOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListOnPremisesInstances.</param> <returns>Returns a ListOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest)"> <summary> Registers with AWS CodeDeploy a revision for the specified application. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision service method.</param> <returns>The response from the RegisterApplicationRevision service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> The description that was provided is too long. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> The revision was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> The revision ID was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginRegisterApplicationRevision(Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterApplicationRevision operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterApplicationRevision operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndRegisterApplicationRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterApplicationRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterApplicationRevision.</param> <returns>Returns a RegisterApplicationRevisionResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest)"> <summary> Registers an on-premises instance. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance service method.</param> <returns>The response from the RegisterOnPremisesInstance service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException"> The specified IAM user ARN is already registered with an on-premises instance. </exception> <exception cref="T:Amazon.CodeDeploy.Model.IamUserArnRequiredException"> An IAM user ARN was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException"> The specified on-premises instance name is already registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidIamUserArnException"> The IAM user ARN was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> The specified on-premises instance name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginRegisterOnPremisesInstance(Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterOnPremisesInstance operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterOnPremisesInstance operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndRegisterOnPremisesInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterOnPremisesInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterOnPremisesInstance.</param> <returns>Returns a RegisterOnPremisesInstanceResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.RemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest)"> <summary> Removes one or more tags from one or more on-premises instances. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances service method.</param> <returns>The response from the RemoveTagsFromOnPremisesInstances service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> The maximum number of allowed on-premises instances in a single call was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> An on-premises instance name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> The specified on-premises instance is not registered. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> The maximum allowed number of tags was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TagRequiredException"> A tag was not specified. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginRemoveTagsFromOnPremisesInstances(Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTagsFromOnPremisesInstances operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRemoveTagsFromOnPremisesInstances operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndRemoveTagsFromOnPremisesInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTagsFromOnPremisesInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTagsFromOnPremisesInstances.</param> <returns>Returns a RemoveTagsFromOnPremisesInstancesResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.StopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest)"> <summary> Attempts to stop an ongoing deployment. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment service method.</param> <returns>The response from the StopDeployment service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException"> The deployment is already completed. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> The deployment does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> At least one deployment ID must be specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> At least one of the deployment IDs was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginStopDeployment(Amazon.CodeDeploy.Model.StopDeploymentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopDeployment operation. </summary> <param name="request">Container for the necessary parameters to execute the StopDeployment operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopDeployment operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndStopDeployment(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopDeployment operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopDeployment.</param> <returns>Returns a StopDeploymentResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest)"> <summary> Changes an existing application's name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication service method.</param> <returns>The response from the UpdateApplication service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> An application with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginUpdateApplication(Amazon.CodeDeploy.Model.UpdateApplicationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateApplication operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateApplication operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodeDeploy.AmazonCodeDeployClient.EndUpdateApplication(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateApplication operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateApplication.</param> <returns>Returns a UpdateApplicationResult from CodeDeploy.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.UpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest)"> <summary> Changes information about an existing deployment group. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup service method.</param> <returns>The response from the UpdateDeploymentGroup service method, as returned by CodeDeploy.</returns> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> The application does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> The minimum number of required application names was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> The deployment configuration does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> A deployment group with the specified name already exists with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> The named deployment group does not exist with the applicable IAM user or AWS account. </exception> <exception cref="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> The deployment group name was not specified. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> The application name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> The Auto Scaling group was specified in an invalid format or does not exist. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> The deployment configuration name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> The deployment group name was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> The tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidRoleException"> The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTagException"> The specified tag was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> The trigger was specified in an invalid format. </exception> <exception cref="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> The limit for lifecycle hooks was exceeded. </exception> <exception cref="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> The maximum allowed number of triggers was exceeded. </exception> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.BeginUpdateDeploymentGroup(Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDeploymentGroup operation on AmazonCodeDeployClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDeploymentGroup operation.</returns> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployClient.EndUpdateDeploymentGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDeploymentGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDeploymentGroup.</param> <returns>Returns a UpdateDeploymentGroupResult from CodeDeploy.</returns> </member> <member name="T:Amazon.CodeDeploy.AmazonCodeDeployConfig"> <summary> Configuration for accessing Amazon CodeDeploy service </summary> </member> <member name="M:Amazon.CodeDeploy.AmazonCodeDeployConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CodeDeploy.AmazonCodeDeployConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CodeDeploy.AmazonCodeDeployConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CodeDeploy.ApplicationRevisionSortBy"> <summary> Constants used for properties of type ApplicationRevisionSortBy. </summary> </member> <member name="F:Amazon.CodeDeploy.ApplicationRevisionSortBy.FirstUsedTime"> <summary> Constant FirstUsedTime for ApplicationRevisionSortBy </summary> </member> <member name="F:Amazon.CodeDeploy.ApplicationRevisionSortBy.LastUsedTime"> <summary> Constant LastUsedTime for ApplicationRevisionSortBy </summary> </member> <member name="F:Amazon.CodeDeploy.ApplicationRevisionSortBy.RegisterTime"> <summary> Constant RegisterTime for ApplicationRevisionSortBy </summary> </member> <member name="M:Amazon.CodeDeploy.ApplicationRevisionSortBy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.ApplicationRevisionSortBy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.BundleType"> <summary> Constants used for properties of type BundleType. </summary> </member> <member name="F:Amazon.CodeDeploy.BundleType.Tar"> <summary> Constant Tar for BundleType </summary> </member> <member name="F:Amazon.CodeDeploy.BundleType.Tgz"> <summary> Constant Tgz for BundleType </summary> </member> <member name="F:Amazon.CodeDeploy.BundleType.Zip"> <summary> Constant Zip for BundleType </summary> </member> <member name="M:Amazon.CodeDeploy.BundleType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.BundleType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.DeploymentCreator"> <summary> Constants used for properties of type DeploymentCreator. </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentCreator.Autoscaling"> <summary> Constant Autoscaling for DeploymentCreator </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentCreator.User"> <summary> Constant User for DeploymentCreator </summary> </member> <member name="M:Amazon.CodeDeploy.DeploymentCreator.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.DeploymentCreator.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.DeploymentStatus"> <summary> Constants used for properties of type DeploymentStatus. </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.Created"> <summary> Constant Created for DeploymentStatus </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.Failed"> <summary> Constant Failed for DeploymentStatus </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.InProgress"> <summary> Constant InProgress for DeploymentStatus </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.Queued"> <summary> Constant Queued for DeploymentStatus </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.Stopped"> <summary> Constant Stopped for DeploymentStatus </summary> </member> <member name="F:Amazon.CodeDeploy.DeploymentStatus.Succeeded"> <summary> Constant Succeeded for DeploymentStatus </summary> </member> <member name="M:Amazon.CodeDeploy.DeploymentStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.DeploymentStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.EC2TagFilterType"> <summary> Constants used for properties of type EC2TagFilterType. </summary> </member> <member name="F:Amazon.CodeDeploy.EC2TagFilterType.KEY_AND_VALUE"> <summary> Constant KEY_AND_VALUE for EC2TagFilterType </summary> </member> <member name="F:Amazon.CodeDeploy.EC2TagFilterType.KEY_ONLY"> <summary> Constant KEY_ONLY for EC2TagFilterType </summary> </member> <member name="F:Amazon.CodeDeploy.EC2TagFilterType.VALUE_ONLY"> <summary> Constant VALUE_ONLY for EC2TagFilterType </summary> </member> <member name="M:Amazon.CodeDeploy.EC2TagFilterType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.EC2TagFilterType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.ErrorCode"> <summary> Constants used for properties of type ErrorCode. </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.APPLICATION_MISSING"> <summary> Constant APPLICATION_MISSING for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.DEPLOYMENT_GROUP_MISSING"> <summary> Constant DEPLOYMENT_GROUP_MISSING for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.HEALTH_CONSTRAINTS"> <summary> Constant HEALTH_CONSTRAINTS for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.HEALTH_CONSTRAINTS_INVALID"> <summary> Constant HEALTH_CONSTRAINTS_INVALID for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.IAM_ROLE_MISSING"> <summary> Constant IAM_ROLE_MISSING for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.IAM_ROLE_PERMISSIONS"> <summary> Constant IAM_ROLE_PERMISSIONS for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.INTERNAL_ERROR"> <summary> Constant INTERNAL_ERROR for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.NO_EC2_SUBSCRIPTION"> <summary> Constant NO_EC2_SUBSCRIPTION for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.NO_INSTANCES"> <summary> Constant NO_INSTANCES for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.OVER_MAX_INSTANCES"> <summary> Constant OVER_MAX_INSTANCES for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.REVISION_MISSING"> <summary> Constant REVISION_MISSING for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.THROTTLED"> <summary> Constant THROTTLED for ErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.ErrorCode.TIMEOUT"> <summary> Constant TIMEOUT for ErrorCode </summary> </member> <member name="M:Amazon.CodeDeploy.ErrorCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.ErrorCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.InstanceStatus"> <summary> Constants used for properties of type InstanceStatus. </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.Failed"> <summary> Constant Failed for InstanceStatus </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.InProgress"> <summary> Constant InProgress for InstanceStatus </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.Pending"> <summary> Constant Pending for InstanceStatus </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.Skipped"> <summary> Constant Skipped for InstanceStatus </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.Succeeded"> <summary> Constant Succeeded for InstanceStatus </summary> </member> <member name="F:Amazon.CodeDeploy.InstanceStatus.Unknown"> <summary> Constant Unknown for InstanceStatus </summary> </member> <member name="M:Amazon.CodeDeploy.InstanceStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.InstanceStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.LifecycleErrorCode"> <summary> Constants used for properties of type LifecycleErrorCode. </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.ScriptFailed"> <summary> Constant ScriptFailed for LifecycleErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.ScriptMissing"> <summary> Constant ScriptMissing for LifecycleErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.ScriptNotExecutable"> <summary> Constant ScriptNotExecutable for LifecycleErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.ScriptTimedOut"> <summary> Constant ScriptTimedOut for LifecycleErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.Success"> <summary> Constant Success for LifecycleErrorCode </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleErrorCode.UnknownError"> <summary> Constant UnknownError for LifecycleErrorCode </summary> </member> <member name="M:Amazon.CodeDeploy.LifecycleErrorCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.LifecycleErrorCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.LifecycleEventStatus"> <summary> Constants used for properties of type LifecycleEventStatus. </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.Failed"> <summary> Constant Failed for LifecycleEventStatus </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.InProgress"> <summary> Constant InProgress for LifecycleEventStatus </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.Pending"> <summary> Constant Pending for LifecycleEventStatus </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.Skipped"> <summary> Constant Skipped for LifecycleEventStatus </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.Succeeded"> <summary> Constant Succeeded for LifecycleEventStatus </summary> </member> <member name="F:Amazon.CodeDeploy.LifecycleEventStatus.Unknown"> <summary> Constant Unknown for LifecycleEventStatus </summary> </member> <member name="M:Amazon.CodeDeploy.LifecycleEventStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.LifecycleEventStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.ListStateFilterAction"> <summary> Constants used for properties of type ListStateFilterAction. </summary> </member> <member name="F:Amazon.CodeDeploy.ListStateFilterAction.Exclude"> <summary> Constant Exclude for ListStateFilterAction </summary> </member> <member name="F:Amazon.CodeDeploy.ListStateFilterAction.Ignore"> <summary> Constant Ignore for ListStateFilterAction </summary> </member> <member name="F:Amazon.CodeDeploy.ListStateFilterAction.Include"> <summary> Constant Include for ListStateFilterAction </summary> </member> <member name="M:Amazon.CodeDeploy.ListStateFilterAction.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.ListStateFilterAction.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.MinimumHealthyHostsType"> <summary> Constants used for properties of type MinimumHealthyHostsType. </summary> </member> <member name="F:Amazon.CodeDeploy.MinimumHealthyHostsType.FLEET_PERCENT"> <summary> Constant FLEET_PERCENT for MinimumHealthyHostsType </summary> </member> <member name="F:Amazon.CodeDeploy.MinimumHealthyHostsType.HOST_COUNT"> <summary> Constant HOST_COUNT for MinimumHealthyHostsType </summary> </member> <member name="M:Amazon.CodeDeploy.MinimumHealthyHostsType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.MinimumHealthyHostsType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.RegistrationStatus"> <summary> Constants used for properties of type RegistrationStatus. </summary> </member> <member name="F:Amazon.CodeDeploy.RegistrationStatus.Deregistered"> <summary> Constant Deregistered for RegistrationStatus </summary> </member> <member name="F:Amazon.CodeDeploy.RegistrationStatus.Registered"> <summary> Constant Registered for RegistrationStatus </summary> </member> <member name="M:Amazon.CodeDeploy.RegistrationStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.RegistrationStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.RevisionLocationType"> <summary> Constants used for properties of type RevisionLocationType. </summary> </member> <member name="F:Amazon.CodeDeploy.RevisionLocationType.GitHub"> <summary> Constant GitHub for RevisionLocationType </summary> </member> <member name="F:Amazon.CodeDeploy.RevisionLocationType.S3"> <summary> Constant S3 for RevisionLocationType </summary> </member> <member name="M:Amazon.CodeDeploy.RevisionLocationType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.RevisionLocationType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.SortOrder"> <summary> Constants used for properties of type SortOrder. </summary> </member> <member name="F:Amazon.CodeDeploy.SortOrder.Ascending"> <summary> Constant Ascending for SortOrder </summary> </member> <member name="F:Amazon.CodeDeploy.SortOrder.Descending"> <summary> Constant Descending for SortOrder </summary> </member> <member name="M:Amazon.CodeDeploy.SortOrder.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.SortOrder.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.StopStatus"> <summary> Constants used for properties of type StopStatus. </summary> </member> <member name="F:Amazon.CodeDeploy.StopStatus.Pending"> <summary> Constant Pending for StopStatus </summary> </member> <member name="F:Amazon.CodeDeploy.StopStatus.Succeeded"> <summary> Constant Succeeded for StopStatus </summary> </member> <member name="M:Amazon.CodeDeploy.StopStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.StopStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.TagFilterType"> <summary> Constants used for properties of type TagFilterType. </summary> </member> <member name="F:Amazon.CodeDeploy.TagFilterType.KEY_AND_VALUE"> <summary> Constant KEY_AND_VALUE for TagFilterType </summary> </member> <member name="F:Amazon.CodeDeploy.TagFilterType.KEY_ONLY"> <summary> Constant KEY_ONLY for TagFilterType </summary> </member> <member name="F:Amazon.CodeDeploy.TagFilterType.VALUE_ONLY"> <summary> Constant VALUE_ONLY for TagFilterType </summary> </member> <member name="M:Amazon.CodeDeploy.TagFilterType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.TagFilterType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.TriggerEventType"> <summary> Constants used for properties of type TriggerEventType. </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.DeploymentFailure"> <summary> Constant DeploymentFailure for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.DeploymentStart"> <summary> Constant DeploymentStart for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.DeploymentStop"> <summary> Constant DeploymentStop for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.DeploymentSuccess"> <summary> Constant DeploymentSuccess for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.InstanceFailure"> <summary> Constant InstanceFailure for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.InstanceStart"> <summary> Constant InstanceStart for TriggerEventType </summary> </member> <member name="F:Amazon.CodeDeploy.TriggerEventType.InstanceSuccess"> <summary> Constant InstanceSuccess for TriggerEventType </summary> </member> <member name="M:Amazon.CodeDeploy.TriggerEventType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeDeploy.TriggerEventType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest"> <summary> Container for the parameters to the AddTagsToOnPremisesInstances operation. Adds tags to on-premises instances. </summary> </member> <member name="T:Amazon.CodeDeploy.AmazonCodeDeployRequest"> <summary> Base class for CodeDeploy operation requests. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest.InstanceNames"> <summary> Gets and sets the property InstanceNames. <para> The names of the on-premises instances to add tags to. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.AddTagsToOnPremisesInstancesRequest.Tags"> <summary> Gets and sets the property Tags. <para> The tag key-value pairs to add to the on-premises instances. </para> <para> Keys and values are both required. Keys cannot be nulls or empty strings. Value-only tags are not allowed. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.ApplicationAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new ApplicationAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.ApplicationDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new ApplicationDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.ApplicationInfo"> <summary> Information about an application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ApplicationInfo.ApplicationId"> <summary> Gets and sets the property ApplicationId. <para> The application ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ApplicationInfo.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ApplicationInfo.CreateTime"> <summary> Gets and sets the property CreateTime. <para> The time that the application was created. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ApplicationInfo.LinkedToGitHub"> <summary> Gets and sets the property LinkedToGitHub. <para> True if the user has authenticated with GitHub for the specified application; otherwise, false. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ApplicationLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.ApplicationLimitExceededException.#ctor(System.String)"> <summary> Constructs a new ApplicationLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.ApplicationNameRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.ApplicationNameRequiredException.#ctor(System.String)"> <summary> Constructs a new ApplicationNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.AutoScalingGroup"> <summary> Information about an Auto Scaling group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.AutoScalingGroup.Hook"> <summary> Gets and sets the property Hook. <para> An Auto Scaling lifecycle event hook name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.AutoScalingGroup.Name"> <summary> Gets and sets the property Name. <para> The Auto Scaling group name. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest"> <summary> Container for the parameters to the BatchGetApplicationRevisions operation. Gets information about one or more application revisions. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application to get revision information about. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsRequest.Revisions"> <summary> Gets and sets the property Revisions. <para> Information to get about the application revisions, including revision type and location. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResponse"> <summary> Configuration for accessing Amazon BatchGetApplicationRevisions service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResult"> <summary> Represents the output of a batch get application revisions operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application that corresponds to the revisions. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResult.ErrorMessage"> <summary> Gets and sets the property ErrorMessage. <para> Information about errors that may have occurred during the API call. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResult.Revisions"> <summary> Gets and sets the property Revisions. <para> Additional information about the revisions, including the revision type and location. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationRevisionsResponse.BatchGetApplicationRevisionsResult"> <summary> Gets and sets the BatchGetApplicationRevisionsResult property. Represents the output of a BatchGetApplicationRevisions operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationsRequest"> <summary> Container for the parameters to the BatchGetApplications operation. Gets information about one or more applications. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationsRequest.ApplicationNames"> <summary> Gets and sets the property ApplicationNames. <para> A list of application names, with multiple application names separated by spaces. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationsResponse"> <summary> Configuration for accessing Amazon BatchGetApplications service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetApplicationsResult"> <summary> Represents the output of a batch get applications operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationsResult.ApplicationsInfo"> <summary> Gets and sets the property ApplicationsInfo. <para> Information about the applications. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetApplicationsResponse.BatchGetApplicationsResult"> <summary> Gets and sets the BatchGetApplicationsResult property. Represents the output of a BatchGetApplications operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest"> <summary> Container for the parameters to the BatchGetDeploymentInstances operation. Gets information about one or more instances that are part of a deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The unique ID of a deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> The unique IDs of instances in the deployment's deployment group. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesResponse"> <summary> Configuration for accessing Amazon BatchGetDeploymentInstances service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesResult"> <summary> Represents the output of a batch get deployment instances operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesResult.ErrorMessage"> <summary> Gets and sets the property ErrorMessage. <para> Information about errors that may have occurred during the API call. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesResult.InstancesSummary"> <summary> Gets and sets the property InstancesSummary. <para> Information about the instances. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentInstancesResponse.BatchGetDeploymentInstancesResult"> <summary> Gets and sets the BatchGetDeploymentInstancesResult property. Represents the output of a BatchGetDeploymentInstances operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest"> <summary> Container for the parameters to the BatchGetDeployments operation. Gets information about one or more deployments. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentsRequest.DeploymentIds"> <summary> Gets and sets the property DeploymentIds. <para> A list of deployment IDs, with multiple deployment IDs separated by spaces. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentsResponse"> <summary> Configuration for accessing Amazon BatchGetDeployments service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetDeploymentsResult"> <summary> Represents the output of a batch get deployments operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentsResult.DeploymentsInfo"> <summary> Gets and sets the property DeploymentsInfo. <para> Information about the deployments. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetDeploymentsResponse.BatchGetDeploymentsResult"> <summary> Gets and sets the BatchGetDeploymentsResult property. Represents the output of a BatchGetDeployments operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest"> <summary> Container for the parameters to the BatchGetOnPremisesInstances operation. Gets information about one or more on-premises instances. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesRequest.InstanceNames"> <summary> Gets and sets the property InstanceNames. <para> The names of the on-premises instances to get information about. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesResponse"> <summary> Configuration for accessing Amazon BatchGetOnPremisesInstances service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesResult"> <summary> Represents the output of a batch get on-premises instances operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesResult.InstanceInfos"> <summary> Gets and sets the property InstanceInfos. <para> Information about the on-premises instances. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.BatchGetOnPremisesInstancesResponse.BatchGetOnPremisesInstancesResult"> <summary> Gets and sets the BatchGetOnPremisesInstancesResult property. Represents the output of a BatchGetOnPremisesInstances operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.BatchLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.BatchLimitExceededException.#ctor(System.String)"> <summary> Constructs a new BatchLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.BucketNameFilterRequiredException.#ctor(System.String)"> <summary> Constructs a new BucketNameFilterRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.CreateApplicationRequest"> <summary> Container for the parameters to the CreateApplication operation. Creates a new application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application. This name must be unique with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateApplicationResponse"> <summary> Configuration for accessing Amazon CreateApplication service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateApplicationResult"> <summary> Represents the output of a create application operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateApplicationResult.ApplicationId"> <summary> Gets and sets the property ApplicationId. <para> A unique application ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateApplicationResponse.CreateApplicationResult"> <summary> Gets and sets the CreateApplicationResult property. Represents the output of a CreateApplication operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest"> <summary> Container for the parameters to the CreateDeploymentConfig operation. Creates a new deployment configuration. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The name of the deployment configuration to create. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentConfigRequest.MinimumHealthyHosts"> <summary> Gets and sets the property MinimumHealthyHosts. <para> The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value. </para> <para> The type parameter takes either of the following values: </para> <ul> <li>HOST_COUNT: The value parameter represents the minimum number of healthy instances, as an absolute value.</li> <li>FLEET_PERCENT: The value parameter represents the minimum number of healthy instances, as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, then at the start of the deployment AWS CodeDeploy converts the percentage to the equivalent number of instances and rounds fractional instances up.</li> </ul> <para> The value parameter takes an integer. </para> <para> For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentConfigResponse"> <summary> Configuration for accessing Amazon CreateDeploymentConfig service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentConfigResult"> <summary> Represents the output of a create deployment configuration operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentConfigResult.DeploymentConfigId"> <summary> Gets and sets the property DeploymentConfigId. <para> A unique deployment configuration ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentConfigResponse.CreateDeploymentConfigResult"> <summary> Gets and sets the CreateDeploymentConfigResult property. Represents the output of a CreateDeploymentConfig operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest"> <summary> Container for the parameters to the CreateDeploymentGroup operation. Creates a new deployment group for application revisions to be deployed to. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> A list of associated Auto Scaling groups. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy, or a custom deployment configuration that you created by calling the create deployment configuration operation. </para> <note> <para> CodeDeployDefault.OneAtATime is the default deployment configuration that is used if a configuration isn't specified for either the deployment or the deployment group. </para> </note> <para> The predefined deployment configurations including the following: </para> <ul> <li> <para> <b>CodeDeployDefault.AllAtOnce</b> attempts to deploy an application revision to as many instances as possible at once. The status of the overall deployment will be displayed as <b>Succeeded</b> if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as <b>Failed</b> if the application revision is not deployed to any of the instances. Using an example of nine instances, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instances at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instances fail. </para> </li> <li> <para> <b>CodeDeployDefault.HalfAtATime</b> deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision deploys to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. For example, for nine instances, deploy to up to four instances at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. </para> </li> <li> <para> <b>CodeDeployDefault.OneAtATime</b> deploys the application revision to only one instance at a time. </para> <para> For deployment groups that contain more than one instance: </para> <ul> <li> <para> The overall deployment succeeds if the application revision deploys to all of the instances. The exception to this rule is that if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance to be taken offline at a time with the CodeDeployDefault.OneAtATime configuration. </para> </li> <li> <para> The overall deployment fails as soon as the application revision fails to deploy to any but the last instance. Note that the deployment may successfully deploy to some instances, even if the overall deployment fails. </para> </li> <li> <para> Example: For nine instances, deploy to one instance at a time. The overall deployment succeeds if the first eight instances are successfully deployed to, but it fails if deployment to any of the first eight instances fails. </para> </li> </ul> <para> For deployment groups that contain only one instance, the overall deployment is of course successful only if deployment to the single instance succeeds. </para> </li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The name of a new deployment group for the specified application. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.Ec2TagFilters"> <summary> Gets and sets the property Ec2TagFilters. <para> The Amazon EC2 tags to filter on. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.OnPremisesInstanceTagFilters"> <summary> Gets and sets the property OnPremisesInstanceTagFilters. <para> The on-premises instance tags to filter on. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.ServiceRoleArn"> <summary> Gets and sets the property ServiceRoleArn. <para> A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupRequest.TriggerConfigurations"> <summary> Gets and sets the property TriggerConfigurations. <para> Information about triggers to create when the deployment group is created. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentGroupResponse"> <summary> Configuration for accessing Amazon CreateDeploymentGroup service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentGroupResult"> <summary> Represents the output of a create deployment group operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupResult.DeploymentGroupId"> <summary> Gets and sets the property DeploymentGroupId. <para> A unique deployment group ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentGroupResponse.CreateDeploymentGroupResult"> <summary> Gets and sets the CreateDeploymentGroupResult property. Represents the output of a CreateDeploymentGroup operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentRequest"> <summary> Container for the parameters to the CreateDeployment operation. Deploys an application revision through the specified deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The name of an existing deployment configuration associated with the applicable IAM user or AWS account. </para> <para> If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The deployment group's name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.Description"> <summary> Gets and sets the property Description. <para> A comment about the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.IgnoreApplicationStopFailures"> <summary> Gets and sets the property IgnoreApplicationStopFailures. <para> If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event. </para> <para> If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentRequest.Revision"> <summary> Gets and sets the property Revision. <para> The type of revision to deploy, along with information about the revision's location. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentResponse"> <summary> Configuration for accessing Amazon CreateDeployment service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.CreateDeploymentResult"> <summary> Represents the output of a create deployment operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentResult.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> A unique deployment ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.CreateDeploymentResponse.CreateDeploymentResult"> <summary> Gets and sets the CreateDeploymentResult property. Represents the output of a CreateDeployment operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeleteApplicationRequest"> <summary> Container for the parameters to the DeleteApplication operation. Deletes an application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest"> <summary> Container for the parameters to the DeleteDeploymentConfig operation. Deletes a deployment configuration. <note>A deployment configuration cannot be deleted if it is currently in use. Also, predefined configurations cannot be deleted.</note> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteDeploymentConfigRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The name of an existing deployment configuration associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest"> <summary> Container for the parameters to the DeleteDeploymentGroup operation. Deletes a deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteDeploymentGroupRequest.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The name of an existing deployment group for the specified application. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeleteDeploymentGroupResponse"> <summary> Configuration for accessing Amazon DeleteDeploymentGroup service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeleteDeploymentGroupResult"> <summary> Represents the output of a delete deployment group operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteDeploymentGroupResult.HooksNotCleanedUp"> <summary> Gets and sets the property HooksNotCleanedUp. <para> If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeleteDeploymentGroupResponse.DeleteDeploymentGroupResult"> <summary> Gets and sets the DeleteDeploymentGroupResult property. Represents the output of a DeleteDeploymentGroup operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentAlreadyCompletedException.#ctor(System.String)"> <summary> Constructs a new DeploymentAlreadyCompletedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentConfigAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new DeploymentConfigAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentConfigDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new DeploymentConfigDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigInfo"> <summary> Information about a deployment configuration. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentConfigInfo.CreateTime"> <summary> Gets and sets the property CreateTime. <para> The time that the deployment configuration was created. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentConfigInfo.DeploymentConfigId"> <summary> Gets and sets the property DeploymentConfigId. <para> The deployment configuration ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentConfigInfo.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The deployment configuration name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentConfigInfo.MinimumHealthyHosts"> <summary> Gets and sets the property MinimumHealthyHosts. <para> Information about the number or percentage of minimum healthy instances. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigInUseException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentConfigInUseException.#ctor(System.String)"> <summary> Constructs a new DeploymentConfigInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentConfigLimitExceededException.#ctor(System.String)"> <summary> Constructs a new DeploymentConfigLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentConfigNameRequiredException.#ctor(System.String)"> <summary> Constructs a new DeploymentConfigNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new DeploymentDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentGroupAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new DeploymentGroupAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentGroupDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new DeploymentGroupDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentGroupInfo"> <summary> Information about a deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> A list of associated Auto Scaling groups. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The deployment configuration name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.DeploymentGroupId"> <summary> Gets and sets the property DeploymentGroupId. <para> The deployment group ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The deployment group name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.Ec2TagFilters"> <summary> Gets and sets the property Ec2TagFilters. <para> The Amazon EC2 tags to filter on. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.OnPremisesInstanceTagFilters"> <summary> Gets and sets the property OnPremisesInstanceTagFilters. <para> The on-premises instance tags to filter on. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.ServiceRoleArn"> <summary> Gets and sets the property ServiceRoleArn. <para> A service role ARN. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.TargetRevision"> <summary> Gets and sets the property TargetRevision. <para> Information about the deployment group's target revision, including the revision's type and its location. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentGroupInfo.TriggerConfigurations"> <summary> Gets and sets the property TriggerConfigurations. <para> A list of associated triggers. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentGroupLimitExceededException.#ctor(System.String)"> <summary> Constructs a new DeploymentGroupLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentGroupNameRequiredException.#ctor(System.String)"> <summary> Constructs a new DeploymentGroupNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentIdRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentIdRequiredException.#ctor(System.String)"> <summary> Constructs a new DeploymentIdRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentInfo"> <summary> Information about a deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.CompleteTime"> <summary> Gets and sets the property CompleteTime. <para> A timestamp indicating when the deployment was completed. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.CreateTime"> <summary> Gets and sets the property CreateTime. <para> A timestamp indicating when the deployment was created. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.Creator"> <summary> Gets and sets the property Creator. <para> How the deployment was created: </para> <ul> <li>user: A user created the deployment.</li> <li>autoscaling: Auto Scaling created the deployment.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The deployment configuration name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The deployment group name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The deployment ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.DeploymentOverview"> <summary> Gets and sets the property DeploymentOverview. <para> A summary of the deployment status of the instances in the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.Description"> <summary> Gets and sets the property Description. <para> A comment about the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.ErrorInformation"> <summary> Gets and sets the property ErrorInformation. <para> Information about any error associated with this deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.IgnoreApplicationStopFailures"> <summary> Gets and sets the property IgnoreApplicationStopFailures. <para> If true, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will not be considered to have failed to that instance at that point and will continue on to the BeforeInstall deployment lifecycle event. </para> <para> If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.Revision"> <summary> Gets and sets the property Revision. <para> Information about the location of application artifacts that are stored and the service to retrieve them from. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.StartTime"> <summary> Gets and sets the property StartTime. <para> A timestamp indicating when the deployment began deploying to the deployment group. </para> <para> Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentInfo.Status"> <summary> Gets and sets the property Status. <para> The current state of the deployment as a whole. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentLimitExceededException.#ctor(System.String)"> <summary> Constructs a new DeploymentLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentNotStartedException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DeploymentNotStartedException.#ctor(System.String)"> <summary> Constructs a new DeploymentNotStartedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.DeploymentOverview"> <summary> Information about the deployment status of the instances in the deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentOverview.Failed"> <summary> Gets and sets the property Failed. <para> The number of instances that have failed in the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentOverview.InProgress"> <summary> Gets and sets the property InProgress. <para> The number of instances that are in progress in the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentOverview.Pending"> <summary> Gets and sets the property Pending. <para> The number of instances that are pending in the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentOverview.Skipped"> <summary> Gets and sets the property Skipped. <para> The number of instances that have been skipped in the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeploymentOverview.Succeeded"> <summary> Gets and sets the property Succeeded. <para> The number of instances that have succeeded in the deployment. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest"> <summary> Container for the parameters to the DeregisterOnPremisesInstance operation. Deregisters an on-premises instance. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.DeregisterOnPremisesInstanceRequest.InstanceName"> <summary> Gets and sets the property InstanceName. <para> The name of the on-premises instance to deregister. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.DescriptionTooLongException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.DescriptionTooLongException.#ctor(System.String)"> <summary> Constructs a new DescriptionTooLongException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.Diagnostics"> <summary> Diagnostic information about executable scripts that are part of a deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Diagnostics.ErrorCode"> <summary> Gets and sets the property ErrorCode. <para> The associated error code: </para> <ul> <li>Success: The specified script ran.</li> <li>ScriptMissing: The specified script was not found in the specified location.</li> <li>ScriptNotExecutable: The specified script is not a recognized executable file type.</li> <li>ScriptTimedOut: The specified script did not finish running in the specified time period.</li> <li>ScriptFailed: The specified script failed to run as expected.</li> <li>UnknownError: The specified script did not run for an unknown reason.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Diagnostics.LogTail"> <summary> Gets and sets the property LogTail. <para> The last portion of the associated diagnostic log. </para> <para> If available, AWS CodeDeploy returns up to the last 4 KB of the associated diagnostic log. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Diagnostics.Message"> <summary> Gets and sets the property Message. <para> The message associated with the error. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Diagnostics.ScriptName"> <summary> Gets and sets the property ScriptName. <para> The name of the script. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.EC2TagFilter"> <summary> Information about a tag filter. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.EC2TagFilter.Key"> <summary> Gets and sets the property Key. <para> The tag filter key. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.EC2TagFilter.Type"> <summary> Gets and sets the property Type. <para> The tag filter type: </para> <ul> <li>KEY_ONLY: Key only.</li> <li>VALUE_ONLY: Value only.</li> <li>KEY_AND_VALUE: Key and value.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.EC2TagFilter.Value"> <summary> Gets and sets the property Value. <para> The tag filter value. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ErrorInformation"> <summary> Information about a deployment error. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ErrorInformation.Code"> <summary> Gets and sets the property Code. <para> The error code: </para> <ul> <li>APPLICATION_MISSING: The application was missing. Note that this error code will most likely be raised if the application is deleted after the deployment is created but before it starts.</li> <li>DEPLOYMENT_GROUP_MISSING: The deployment group was missing. Note that this error code will most likely be raised if the deployment group is deleted after the deployment is created but before it starts.</li> <li>HEALTH_CONSTRAINTS: The deployment failed on too many instances to be able to successfully deploy within the specified instance health constraints.</li> <li>HEALTH_CONSTRAINTS_INVALID: The revision can never successfully deploy within the instance health constraints as specified.</li> <li>IAM_ROLE_MISSING: The service role cannot be accessed.</li> <li>IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.</li> <li>INTERNAL_ERROR: There was an internal error.</li> <li>NO_EC2_SUBSCRIPTION: The calling account is not subscribed to the Amazon EC2 service.</li> <li>NO_INSTANCES: No instances were specified, or no instances can be found.</li> <li>OVER_MAX_INSTANCES: The maximum number of instances was exceeded.</li> <li>THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.</li> <li>TIMEOUT: The deployment has timed out.</li> <li>REVISION_MISSING: The revision ID was missing. Note that this error code will most likely be raised if the revision is deleted after the deployment is created but before it starts.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ErrorInformation.Message"> <summary> Gets and sets the property Message. <para> An accompanying error message. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GenericRevisionInfo"> <summary> Information about an application revision. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GenericRevisionInfo.DeploymentGroups"> <summary> Gets and sets the property DeploymentGroups. <para> The deployment groups where this is the current target revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GenericRevisionInfo.Description"> <summary> Gets and sets the property Description. <para> A comment about the revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GenericRevisionInfo.FirstUsedTime"> <summary> Gets and sets the property FirstUsedTime. <para> When the revision was first used by AWS CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GenericRevisionInfo.LastUsedTime"> <summary> Gets and sets the property LastUsedTime. <para> When the revision was last used by AWS CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GenericRevisionInfo.RegisterTime"> <summary> Gets and sets the property RegisterTime. <para> When the revision was registered with AWS CodeDeploy. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationRequest"> <summary> Container for the parameters to the GetApplication operation. Gets information about an application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationResponse"> <summary> Configuration for accessing Amazon GetApplication service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationResult"> <summary> Represents the output of a get application operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationResult.Application"> <summary> Gets and sets the property Application. <para> Information about the application. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationResponse.GetApplicationResult"> <summary> Gets and sets the GetApplicationResult property. Represents the output of a GetApplication operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationRevisionRequest"> <summary> Container for the parameters to the GetApplicationRevision operation. Gets information about an application revision. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application that corresponds to the revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionRequest.Revision"> <summary> Gets and sets the property Revision. <para> Information about the application revision to get, including the revision's type and its location. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationRevisionResponse"> <summary> Configuration for accessing Amazon GetApplicationRevision service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetApplicationRevisionResult"> <summary> Represents the output of a get application revision operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of the application that corresponds to the revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionResult.Revision"> <summary> Gets and sets the property Revision. <para> Additional information about the revision, including the revision's type and its location. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionResult.RevisionInfo"> <summary> Gets and sets the property RevisionInfo. <para> General information about the revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetApplicationRevisionResponse.GetApplicationRevisionResult"> <summary> Gets and sets the GetApplicationRevisionResult property. Represents the output of a GetApplicationRevision operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentConfigRequest"> <summary> Container for the parameters to the GetDeploymentConfig operation. Gets information about a deployment configuration. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentConfigRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The name of an existing deployment configuration associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentConfigResponse"> <summary> Configuration for accessing Amazon GetDeploymentConfig service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentConfigResult"> <summary> Represents the output of a get deployment configuration operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentConfigResult.DeploymentConfigInfo"> <summary> Gets and sets the property DeploymentConfigInfo. <para> Information about the deployment configuration. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentConfigResponse.GetDeploymentConfigResult"> <summary> Gets and sets the GetDeploymentConfigResult property. Represents the output of a GetDeploymentConfig operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentGroupRequest"> <summary> Container for the parameters to the GetDeploymentGroup operation. Gets information about a deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentGroupRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentGroupRequest.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The name of an existing deployment group for the specified application. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentGroupResponse"> <summary> Configuration for accessing Amazon GetDeploymentGroup service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentGroupResult"> <summary> Represents the output of a get deployment group operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentGroupResult.DeploymentGroupInfo"> <summary> Gets and sets the property DeploymentGroupInfo. <para> Information about the deployment group. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentGroupResponse.GetDeploymentGroupResult"> <summary> Gets and sets the GetDeploymentGroupResult property. Represents the output of a GetDeploymentGroup operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest"> <summary> Container for the parameters to the GetDeploymentInstance operation. Gets information about an instance as part of a deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The unique ID of a deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentInstanceRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The unique ID of an instance in the deployment's deployment group. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentInstanceResponse"> <summary> Configuration for accessing Amazon GetDeploymentInstance service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentInstanceResult"> <summary> Represents the output of a get deployment instance operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentInstanceResult.InstanceSummary"> <summary> Gets and sets the property InstanceSummary. <para> Information about the instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentInstanceResponse.GetDeploymentInstanceResult"> <summary> Gets and sets the GetDeploymentInstanceResult property. Represents the output of a GetDeploymentInstance operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentRequest"> <summary> Container for the parameters to the GetDeployment operation. Gets information about a deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentRequest.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> An existing deployment ID associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentResponse"> <summary> Configuration for accessing Amazon GetDeployment service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetDeploymentResult"> <summary> Represents the output of a get deployment operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentResult.DeploymentInfo"> <summary> Gets and sets the property DeploymentInfo. <para> Information about the deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetDeploymentResponse.GetDeploymentResult"> <summary> Gets and sets the GetDeploymentResult property. Represents the output of a GetDeployment operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest"> <summary> Container for the parameters to the GetOnPremisesInstance operation. Gets information about an on-premises instance. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetOnPremisesInstanceRequest.InstanceName"> <summary> Gets and sets the property InstanceName. <para> The name of the on-premises instance to get information about </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetOnPremisesInstanceResponse"> <summary> Configuration for accessing Amazon GetOnPremisesInstance service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GetOnPremisesInstanceResult"> <summary> Represents the output of a get on-premises instance operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetOnPremisesInstanceResult.InstanceInfo"> <summary> Gets and sets the property InstanceInfo. <para> Information about the on-premises instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GetOnPremisesInstanceResponse.GetOnPremisesInstanceResult"> <summary> Gets and sets the GetOnPremisesInstanceResult property. Represents the output of a GetOnPremisesInstance operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.GitHubLocation"> <summary> Information about the location of application artifacts that are stored in GitHub. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GitHubLocation.CommitId"> <summary> Gets and sets the property CommitId. <para> The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.GitHubLocation.Repository"> <summary> Gets and sets the property Repository. <para> The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision. </para> <para> Specified as account/repository. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.IamUserArnAlreadyRegisteredException.#ctor(System.String)"> <summary> Constructs a new IamUserArnAlreadyRegisteredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.IamUserArnRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.IamUserArnRequiredException.#ctor(System.String)"> <summary> Constructs a new IamUserArnRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new InstanceDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceIdRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceIdRequiredException.#ctor(System.String)"> <summary> Constructs a new InstanceIdRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceInfo"> <summary> Information about an on-premises instance. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.DeregisterTime"> <summary> Gets and sets the property DeregisterTime. <para> If the on-premises instance was deregistered, the time that the on-premises instance was deregistered. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.IamUserArn"> <summary> Gets and sets the property IamUserArn. <para> The IAM user ARN associated with the on-premises instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.InstanceArn"> <summary> Gets and sets the property InstanceArn. <para> The ARN of the on-premises instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.InstanceName"> <summary> Gets and sets the property InstanceName. <para> The name of the on-premises instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.RegisterTime"> <summary> Gets and sets the property RegisterTime. <para> The time that the on-premises instance was registered. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceInfo.Tags"> <summary> Gets and sets the property Tags. <para> The tags that are currently associated with the on-premises instance. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceLimitExceededException.#ctor(System.String)"> <summary> Constructs a new InstanceLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceNameAlreadyRegisteredException.#ctor(System.String)"> <summary> Constructs a new InstanceNameAlreadyRegisteredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceNameRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceNameRequiredException.#ctor(System.String)"> <summary> Constructs a new InstanceNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceNotRegisteredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InstanceNotRegisteredException.#ctor(System.String)"> <summary> Constructs a new InstanceNotRegisteredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InstanceSummary"> <summary> Information about an instance in a deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceSummary.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The deployment ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceSummary.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The instance ID. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceSummary.LastUpdatedAt"> <summary> Gets and sets the property LastUpdatedAt. <para> A timestamp indicating when the instance information was last updated. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceSummary.LifecycleEvents"> <summary> Gets and sets the property LifecycleEvents. <para> A list of lifecycle events for this instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.InstanceSummary.Status"> <summary> Gets and sets the property Status. <para> The deployment status for this instance: </para> <ul> <li>Pending: The deployment is pending for this instance.</li> <li>In Progress: The deployment is in progress for this instance.</li> <li>Succeeded: The deployment has succeeded for this instance.</li> <li>Failed: The deployment has failed for this instance.</li> <li>Skipped: The deployment has been skipped for this instance.</li> <li>Unknown: The deployment status is unknown for this instance.</li> </ul> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidApplicationNameException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidApplicationNameException.#ctor(System.String)"> <summary> Constructs a new InvalidApplicationNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidAutoScalingGroupException.#ctor(System.String)"> <summary> Constructs a new InvalidAutoScalingGroupException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidBucketNameFilterException.#ctor(System.String)"> <summary> Constructs a new InvalidBucketNameFilterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidDeployedStateFilterException.#ctor(System.String)"> <summary> Constructs a new InvalidDeployedStateFilterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidDeploymentConfigNameException.#ctor(System.String)"> <summary> Constructs a new InvalidDeploymentConfigNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidDeploymentGroupNameException.#ctor(System.String)"> <summary> Constructs a new InvalidDeploymentGroupNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidDeploymentIdException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidDeploymentIdException.#ctor(System.String)"> <summary> Constructs a new InvalidDeploymentIdException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidDeploymentStatusException.#ctor(System.String)"> <summary> Constructs a new InvalidDeploymentStatusException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidEC2TagException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidEC2TagException.#ctor(System.String)"> <summary> Constructs a new InvalidEC2TagException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidIamUserArnException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidIamUserArnException.#ctor(System.String)"> <summary> Constructs a new InvalidIamUserArnException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidInstanceNameException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidInstanceNameException.#ctor(System.String)"> <summary> Constructs a new InvalidInstanceNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidInstanceStatusException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidInstanceStatusException.#ctor(System.String)"> <summary> Constructs a new InvalidInstanceStatusException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidKeyPrefixFilterException.#ctor(System.String)"> <summary> Constructs a new InvalidKeyPrefixFilterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidMinimumHealthyHostValueException.#ctor(System.String)"> <summary> Constructs a new InvalidMinimumHealthyHostValueException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidNextTokenException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.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.CodeDeploy.Model.InvalidOperationException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidOperationException.#ctor(System.String)"> <summary> Constructs a new InvalidOperationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidRegistrationStatusException.#ctor(System.String)"> <summary> Constructs a new InvalidRegistrationStatusException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidRevisionException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidRevisionException.#ctor(System.String)"> <summary> Constructs a new InvalidRevisionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidRoleException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidRoleException.#ctor(System.String)"> <summary> Constructs a new InvalidRoleException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidSortByException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidSortByException.#ctor(System.String)"> <summary> Constructs a new InvalidSortByException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidSortOrderException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidSortOrderException.#ctor(System.String)"> <summary> Constructs a new InvalidSortOrderException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidTagException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidTagException.#ctor(System.String)"> <summary> Constructs a new InvalidTagException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidTagFilterException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidTagFilterException.#ctor(System.String)"> <summary> Constructs a new InvalidTagFilterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidTimeRangeException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidTimeRangeException.#ctor(System.String)"> <summary> Constructs a new InvalidTimeRangeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.InvalidTriggerConfigException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.InvalidTriggerConfigException.#ctor(System.String)"> <summary> Constructs a new InvalidTriggerConfigException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.LifecycleEvent"> <summary> Information about a deployment lifecycle event. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.LifecycleEvent.Diagnostics"> <summary> Gets and sets the property Diagnostics. <para> Diagnostic information about the deployment lifecycle event. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.LifecycleEvent.EndTime"> <summary> Gets and sets the property EndTime. <para> A timestamp indicating when the deployment lifecycle event ended. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.LifecycleEvent.LifecycleEventName"> <summary> Gets and sets the property LifecycleEventName. <para> The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.LifecycleEvent.StartTime"> <summary> Gets and sets the property StartTime. <para> A timestamp indicating when the deployment lifecycle event started. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.LifecycleEvent.Status"> <summary> Gets and sets the property Status. <para> The deployment lifecycle event status: </para> <ul> <li>Pending: The deployment lifecycle event is pending.</li> <li>InProgress: The deployment lifecycle event is in progress.</li> <li>Succeeded: The deployment lifecycle event has succeeded.</li> <li>Failed: The deployment lifecycle event has failed.</li> <li>Skipped: The deployment lifecycle event has been skipped.</li> <li>Unknown: The deployment lifecycle event is unknown.</li> </ul> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.LifecycleHookLimitExceededException.#ctor(System.String)"> <summary> Constructs a new LifecycleHookLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest"> <summary> Container for the parameters to the ListApplicationRevisions operation. Lists information about revisions for an application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to list revisions based on whether the revision is the target revision of an deployment group: </para> <ul> <li>include: List revisions that are target revisions of a deployment group.</li> <li>exclude: Do not list revisions that are target revisions of a deployment group.</li> <li>ignore: List all revisions, regardless of whether they are target revisions of a deployment group.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list application revisions call, which can be used to return the next set of applications in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> A specific Amazon S3 bucket name to limit the search for revisions. </para> <para> If set to null, then all of the user's buckets will be searched. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> A specific key prefix for the set of Amazon S3 objects to limit the search for revisions. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.SortBy"> <summary> Gets and sets the property SortBy. <para> The column name to sort the list results by: </para> <ul> <li>registerTime: Sort the list results by when the revisions were registered with AWS CodeDeploy.</li> <li>firstUsedTime: Sort the list results by when the revisions were first used by in a deployment.</li> <li>lastUsedTime: Sort the list results by when the revisions were last used in a deployment.</li> </ul> <para> If not specified or set to null, the results will be returned in an arbitrary order. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsRequest.SortOrder"> <summary> Gets and sets the property SortOrder. <para> The order to sort the list results by: </para> <ul> <li>ascending: Sort the list of results in ascending order.</li> <li>descending: Sort the list of results in descending order.</li> </ul> <para> If not specified, the results will be sorted in ascending order. </para> <para> If set to null, the results will be sorted in an arbitrary order. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationRevisionsResponse"> <summary> Configuration for accessing Amazon ListApplicationRevisions service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationRevisionsResult"> <summary> Represents the output of a list application revisions operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list application revisions call to return the next set of application revisions in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsResult.Revisions"> <summary> Gets and sets the property Revisions. <para> A list of revision locations that contain the matching revisions. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationRevisionsResponse.ListApplicationRevisionsResult"> <summary> Gets and sets the ListApplicationRevisionsResult property. Represents the output of a ListApplicationRevisions operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationsRequest"> <summary> Container for the parameters to the ListApplications operation. Lists the applications registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list applications call, which can be used to return the next set of applications in the list. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationsResponse"> <summary> Configuration for accessing Amazon ListApplications service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListApplicationsResult"> <summary> Represents the output of a list applications operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationsResult.Applications"> <summary> Gets and sets the property Applications. <para> A list of application names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list applications call to return the next set of applications in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListApplicationsResponse.ListApplicationsResult"> <summary> Gets and sets the ListApplicationsResult property. Represents the output of a ListApplications operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest"> <summary> Container for the parameters to the ListDeploymentConfigs operation. Lists the deployment configurations with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentConfigsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list deployment configurations call, which can be used to return the next set of deployment configurations in the list. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentConfigsResponse"> <summary> Configuration for accessing Amazon ListDeploymentConfigs service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentConfigsResult"> <summary> Represents the output of a list deployment configurations operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentConfigsResult.DeploymentConfigsList"> <summary> Gets and sets the property DeploymentConfigsList. <para> A list of deployment configurations, including the built-in configurations such as CodeDeployDefault.OneAtATime. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentConfigsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentConfigsResponse.ListDeploymentConfigsResult"> <summary> Gets and sets the ListDeploymentConfigsResult property. Represents the output of a ListDeploymentConfigs operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest"> <summary> Container for the parameters to the ListDeploymentGroups operation. Lists the deployment groups for an application registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list deployment groups call, which can be used to return the next set of deployment groups in the list. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentGroupsResponse"> <summary> Configuration for accessing Amazon ListDeploymentGroups service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentGroupsResult"> <summary> Represents the output of a list deployment groups operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsResult.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application name. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsResult.DeploymentGroups"> <summary> Gets and sets the property DeploymentGroups. <para> A list of corresponding deployment group names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentGroupsResponse.ListDeploymentGroupsResult"> <summary> Gets and sets the ListDeploymentGroupsResult property. Represents the output of a ListDeploymentGroups operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest"> <summary> Container for the parameters to the ListDeploymentInstances operation. Lists the instances for a deployment associated with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The unique ID of a deployment. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest.InstanceStatusFilter"> <summary> Gets and sets the property InstanceStatusFilter. <para> A subset of instances to list, by status: </para> <ul> <li>Pending: Include in the resulting list those instances with pending deployments.</li> <li>InProgress: Include in the resulting list those instances with in-progress deployments.</li> <li>Succeeded: Include in the resulting list those instances with succeeded deployments.</li> <li>Failed: Include in the resulting list those instances with failed deployments.</li> <li>Skipped: Include in the resulting list those instances with skipped deployments.</li> <li>Unknown: Include in the resulting list those instances with deployments in an unknown state.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list deployment instances call, which can be used to return the next set of deployment instances in the list. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentInstancesResponse"> <summary> Configuration for accessing Amazon ListDeploymentInstances service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentInstancesResult"> <summary> Represents the output of a list deployment instances operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesResult.InstancesList"> <summary> Gets and sets the property InstancesList. <para> A list of instances IDs. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentInstancesResponse.ListDeploymentInstancesResult"> <summary> Gets and sets the ListDeploymentInstancesResult property. Represents the output of a ListDeploymentInstances operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentsRequest"> <summary> Container for the parameters to the ListDeployments operation. Lists the deployments within a deployment group for an application registered with the applicable IAM user or AWS account. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsRequest.CreateTimeRange"> <summary> Gets and sets the property CreateTimeRange. <para> A deployment creation start- and end-time range for returning a subset of the list of deployments. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsRequest.DeploymentGroupName"> <summary> Gets and sets the property DeploymentGroupName. <para> The name of an existing deployment group for the specified application. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsRequest.IncludeOnlyStatuses"> <summary> Gets and sets the property IncludeOnlyStatuses. <para> A subset of deployments to list, by status: </para> <ul> <li>Created: Include in the resulting list created deployments.</li> <li>Queued: Include in the resulting list queued deployments.</li> <li>In Progress: Include in the resulting list in-progress deployments.</li> <li>Succeeded: Include in the resulting list succeeded deployments.</li> <li>Failed: Include in the resulting list failed deployments.</li> <li>Aborted: Include in the resulting list aborted deployments.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list deployments call, which can be used to return the next set of deployments in the list. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentsResponse"> <summary> Configuration for accessing Amazon ListDeployments service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListDeploymentsResult"> <summary> Represents the output of a list deployments operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsResult.Deployments"> <summary> Gets and sets the property Deployments. <para> A list of deployment IDs. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list deployments call to return the next set of deployments in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListDeploymentsResponse.ListDeploymentsResult"> <summary> Gets and sets the ListDeploymentsResult property. Represents the output of a ListDeployments operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest"> <summary> Container for the parameters to the ListOnPremisesInstances operation. Gets a list of one or more on-premises instance names. <para> Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list on-premises instances call, which can be used to return the next set of on-premises instances in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest.RegistrationStatus"> <summary> Gets and sets the property RegistrationStatus. <para> The on-premises instances registration status: </para> <ul> <li>Deregistered: Include in the resulting list deregistered on-premises instances.</li> <li>Registered: Include in the resulting list registered on-premises instances.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesRequest.TagFilters"> <summary> Gets and sets the property TagFilters. <para> The on-premises instance tags that will be used to restrict the corresponding on-premises instance names that are returned. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListOnPremisesInstancesResponse"> <summary> Configuration for accessing Amazon ListOnPremisesInstances service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.ListOnPremisesInstancesResult"> <summary> Represents the output of list on-premises instances operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesResult.InstanceNames"> <summary> Gets and sets the property InstanceNames. <para> The list of matching on-premises instance names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of information that is returned is significantly large, an identifier will also be returned, which can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.ListOnPremisesInstancesResponse.ListOnPremisesInstancesResult"> <summary> Gets and sets the ListOnPremisesInstancesResult property. Represents the output of a ListOnPremisesInstances operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.MinimumHealthyHosts"> <summary> Information about minimum healthy instances. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.MinimumHealthyHosts.Type"> <summary> Gets and sets the property Type. <para> The minimum healthy instances type: </para> <ul> <li>HOST_COUNT: The minimum number of healthy instances, as an absolute value.</li> <li>FLEET_PERCENT: The minimum number of healthy instances, as a percentage of the total number of instances in the deployment.</li> </ul> <para> For example, for 9 instances, if a HOST_COUNT of 6 is specified, deploy to up to 3 instances at a time. The deployment succeeds if 6 or more instances are successfully deployed to; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to 5 instances at a time. The deployment succeeds if 4 or more instances are successfully deployed to; otherwise, the deployment fails. </para> <note>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instances type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all but one instance are kept in healthy states during the deployment operation. While this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.</note> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.MinimumHealthyHosts.Value"> <summary> Gets and sets the property Value. <para> The minimum healthy instances value. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest"> <summary> Container for the parameters to the RegisterApplicationRevision operation. Registers with AWS CodeDeploy a revision for the specified application. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The name of an existing AWS CodeDeploy application associated with the applicable IAM user or AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest.Description"> <summary> Gets and sets the property Description. <para> A comment about the revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RegisterApplicationRevisionRequest.Revision"> <summary> Gets and sets the property Revision. <para> Information about the application revision to register, including the revision's type and its location. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest"> <summary> Container for the parameters to the RegisterOnPremisesInstance operation. Registers an on-premises instance. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest.IamUserArn"> <summary> Gets and sets the property IamUserArn. <para> The ARN of the IAM user to associate with the on-premises instance. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RegisterOnPremisesInstanceRequest.InstanceName"> <summary> Gets and sets the property InstanceName. <para> The name of the on-premises instance to register. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest"> <summary> Container for the parameters to the RemoveTagsFromOnPremisesInstances operation. Removes one or more tags from one or more on-premises instances. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest.InstanceNames"> <summary> Gets and sets the property InstanceNames. <para> The names of the on-premises instances to remove tags from. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RemoveTagsFromOnPremisesInstancesRequest.Tags"> <summary> Gets and sets the property Tags. <para> The tag key-value pairs to remove from the on-premises instances. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RevisionDoesNotExistException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.RevisionDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new RevisionDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.RevisionInfo"> <summary> Information about an application revision. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RevisionInfo.GenericRevisionInfo"> <summary> Gets and sets the property GenericRevisionInfo. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RevisionInfo.RevisionLocation"> <summary> Gets and sets the property RevisionLocation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RevisionLocation"> <summary> Information about an application revision's location. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RevisionLocation.GitHubLocation"> <summary> Gets and sets the property GitHubLocation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RevisionLocation.RevisionType"> <summary> Gets and sets the property RevisionType. <para> The application revision's type: </para> <ul> <li>S3: An application revision stored in Amazon S3.</li> <li>GitHub: An application revision stored in GitHub.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.RevisionLocation.S3Location"> <summary> Gets and sets the property S3Location. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.RevisionRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.RevisionRequiredException.#ctor(System.String)"> <summary> Constructs a new RevisionRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.RoleRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.RoleRequiredException.#ctor(System.String)"> <summary> Constructs a new RoleRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.S3Location"> <summary> Information about the location of application artifacts that are stored in Amazon S3. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.S3Location.Bucket"> <summary> Gets and sets the property Bucket. <para> The name of the Amazon S3 bucket where the application revision is stored. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.S3Location.BundleType"> <summary> Gets and sets the property BundleType. <para> The file type of the application revision. Must be one of the following: </para> <ul> <li>tar: A tar archive file.</li> <li>tgz: A compressed tar archive file.</li> <li>zip: A zip archive file.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.S3Location.ETag"> <summary> Gets and sets the property ETag. <para> The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision. </para> <para> If the ETag is not specified as an input parameter, ETag validation of the object will be skipped. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.S3Location.Key"> <summary> Gets and sets the property Key. <para> The name of the Amazon S3 object that represents the bundled artifacts for the application revision. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.S3Location.Version"> <summary> Gets and sets the property Version. <para> A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision. </para> <para> If the version is not specified, the system will use the most recent version by default. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.StopDeploymentRequest"> <summary> Container for the parameters to the StopDeployment operation. Attempts to stop an ongoing deployment. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.StopDeploymentRequest.DeploymentId"> <summary> Gets and sets the property DeploymentId. <para> The unique ID of a deployment. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.StopDeploymentResponse"> <summary> Configuration for accessing Amazon StopDeployment service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.StopDeploymentResult"> <summary> Represents the output of a stop deployment operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.StopDeploymentResult.Status"> <summary> Gets and sets the property Status. <para> The status of the stop deployment operation: </para> <ul> <li>Pending: The stop operation is pending.</li> <li>Succeeded: The stop operation succeeded.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.StopDeploymentResult.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> An accompanying status message. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.StopDeploymentResponse.StopDeploymentResult"> <summary> Gets and sets the StopDeploymentResult property. Represents the output of a StopDeployment operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Tag"> <summary> Information about a tag. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The tag's key. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The tag's value. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.TagFilter"> <summary> Information about an on-premises instance tag filter. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TagFilter.Key"> <summary> Gets and sets the property Key. <para> The on-premises instance tag filter key. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TagFilter.Type"> <summary> Gets and sets the property Type. <para> The on-premises instance tag filter type: </para> <ul> <li>KEY_ONLY: Key only.</li> <li>VALUE_ONLY: Value only.</li> <li>KEY_AND_VALUE: Key and value.</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TagFilter.Value"> <summary> Gets and sets the property Value. <para> The on-premises instance tag filter value. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.TagLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.TagLimitExceededException.#ctor(System.String)"> <summary> Constructs a new TagLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.TagRequiredException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.TagRequiredException.#ctor(System.String)"> <summary> Constructs a new TagRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.TimeRange"> <summary> Information about a time range. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TimeRange.End"> <summary> Gets and sets the property End. <para> The time range's end time. </para> <note>Specify null to leave the time range's end time open-ended.</note> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TimeRange.Start"> <summary> Gets and sets the property Start. <para> The time range's start time. </para> <note>Specify null to leave the time range's start time open-ended.</note> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.TriggerConfig"> <summary> Information about notification triggers for the deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TriggerConfig.TriggerEvents"> <summary> Gets and sets the property TriggerEvents. <para> The event type or types for which notifications are triggered. </para> <para> The following event type values are supported: </para> <ul> <li>DEPLOYMENT_START</li> <li>DEPLOYMENT_SUCCESS</li> <li>DEPLOYMENT_FAILURE</li> <li>DEPLOYMENT_STOP</li> <li>INSTANCE_START</li> <li>INSTANCE_SUCCESS</li> <li>INSTANCE_FAILURE</li> </ul> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TriggerConfig.TriggerName"> <summary> Gets and sets the property TriggerName. <para>The name of the notification trigger.</para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.TriggerConfig.TriggerTargetArn"> <summary> Gets and sets the property TriggerTargetArn. <para> The arn of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException"> <summary> CodeDeploy exception </summary> </member> <member name="M:Amazon.CodeDeploy.Model.TriggerTargetsLimitExceededException.#ctor(System.String)"> <summary> Constructs a new TriggerTargetsLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeDeploy.Model.UpdateApplicationRequest"> <summary> Container for the parameters to the UpdateApplication operation. Changes an existing application's name. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateApplicationRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The current name of the application that you want to change. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateApplicationRequest.NewApplicationName"> <summary> Gets and sets the property NewApplicationName. <para> The new name that you want to change the application to. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest"> <summary> Container for the parameters to the UpdateDeploymentGroup operation. Changes information about an existing deployment group. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.ApplicationName"> <summary> Gets and sets the property ApplicationName. <para> The application name corresponding to the deployment group to update. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.AutoScalingGroups"> <summary> Gets and sets the property AutoScalingGroups. <para> The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the existing Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.CurrentDeploymentGroupName"> <summary> Gets and sets the property CurrentDeploymentGroupName. <para> The current name of the existing deployment group. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.DeploymentConfigName"> <summary> Gets and sets the property DeploymentConfigName. <para> The replacement deployment configuration name to use, if you want to change it. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.Ec2TagFilters"> <summary> Gets and sets the property Ec2TagFilters. <para> The replacement set of Amazon EC2 tags to filter on, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.NewDeploymentGroupName"> <summary> Gets and sets the property NewDeploymentGroupName. <para> The new name of the deployment group, if you want to change it. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.OnPremisesInstanceTagFilters"> <summary> Gets and sets the property OnPremisesInstanceTagFilters. <para> The replacement set of on-premises instance tags for filter on, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.ServiceRoleArn"> <summary> Gets and sets the property ServiceRoleArn. <para> A replacement service role's ARN, if you want to change it. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupRequest.TriggerConfigurations"> <summary> Gets and sets the property TriggerConfigurations. <para> Information about triggers to change when the deployment group is updated. </para> </summary> </member> <member name="T:Amazon.CodeDeploy.Model.UpdateDeploymentGroupResponse"> <summary> Configuration for accessing Amazon UpdateDeploymentGroup service </summary> </member> <member name="T:Amazon.CodeDeploy.Model.UpdateDeploymentGroupResult"> <summary> Represents the output of an update deployment group operation. </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupResult.HooksNotCleanedUp"> <summary> Gets and sets the property HooksNotCleanedUp. <para> If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output does contain data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account. </para> </summary> </member> <member name="P:Amazon.CodeDeploy.Model.UpdateDeploymentGroupResponse.UpdateDeploymentGroupResult"> <summary> Gets and sets the UpdateDeploymentGroupResult property. Represents the output of a UpdateDeploymentGroup operation. </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.AddTagsToOnPremisesInstancesRequestMarshaller"> <summary> AddTagsToOnPremisesInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.AddTagsToOnPremisesInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for AddTagsToOnPremisesInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ApplicationInfoUnmarshaller"> <summary> Response Unmarshaller for ApplicationInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.AutoScalingGroupUnmarshaller"> <summary> Response Unmarshaller for AutoScalingGroup Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetApplicationRevisionsRequestMarshaller"> <summary> BatchGetApplicationRevisions Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetApplicationRevisionsResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetApplicationRevisions operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetApplicationsRequestMarshaller"> <summary> BatchGetApplications Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetApplicationsResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetApplications operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetDeploymentInstancesRequestMarshaller"> <summary> BatchGetDeploymentInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetDeploymentInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetDeploymentInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetDeploymentsRequestMarshaller"> <summary> BatchGetDeployments Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetDeploymentsResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetDeployments operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetOnPremisesInstancesRequestMarshaller"> <summary> BatchGetOnPremisesInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.BatchGetOnPremisesInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetOnPremisesInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateApplicationRequestMarshaller"> <summary> CreateApplication Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for CreateApplication operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentConfigRequestMarshaller"> <summary> CreateDeploymentConfig Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentConfigResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDeploymentConfig operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentGroupRequestMarshaller"> <summary> CreateDeploymentGroup Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDeploymentGroup operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentRequestMarshaller"> <summary> CreateDeployment Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.CreateDeploymentResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDeployment operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteApplicationRequestMarshaller"> <summary> DeleteApplication Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteApplication operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteDeploymentConfigRequestMarshaller"> <summary> DeleteDeploymentConfig Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteDeploymentConfigResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDeploymentConfig operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteDeploymentGroupRequestMarshaller"> <summary> DeleteDeploymentGroup Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeleteDeploymentGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDeploymentGroup operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeploymentConfigInfoUnmarshaller"> <summary> Response Unmarshaller for DeploymentConfigInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeploymentGroupInfoUnmarshaller"> <summary> Response Unmarshaller for DeploymentGroupInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeploymentInfoUnmarshaller"> <summary> Response Unmarshaller for DeploymentInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeploymentOverviewUnmarshaller"> <summary> Response Unmarshaller for DeploymentOverview Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeregisterOnPremisesInstanceRequestMarshaller"> <summary> DeregisterOnPremisesInstance Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DeregisterOnPremisesInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for DeregisterOnPremisesInstance operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.DiagnosticsUnmarshaller"> <summary> Response Unmarshaller for Diagnostics Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.EC2TagFilterMarshaller"> <summary> EC2TagFilter Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.EC2TagFilterUnmarshaller"> <summary> Response Unmarshaller for EC2TagFilter Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ErrorInformationUnmarshaller"> <summary> Response Unmarshaller for ErrorInformation Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GenericRevisionInfoUnmarshaller"> <summary> Response Unmarshaller for GenericRevisionInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetApplicationRequestMarshaller"> <summary> GetApplication Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for GetApplication operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetApplicationRevisionRequestMarshaller"> <summary> GetApplicationRevision Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetApplicationRevisionResponseUnmarshaller"> <summary> Response Unmarshaller for GetApplicationRevision operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentConfigRequestMarshaller"> <summary> GetDeploymentConfig Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentConfigResponseUnmarshaller"> <summary> Response Unmarshaller for GetDeploymentConfig operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentGroupRequestMarshaller"> <summary> GetDeploymentGroup Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentGroupResponseUnmarshaller"> <summary> Response Unmarshaller for GetDeploymentGroup operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentInstanceRequestMarshaller"> <summary> GetDeploymentInstance Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for GetDeploymentInstance operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentRequestMarshaller"> <summary> GetDeployment Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetDeploymentResponseUnmarshaller"> <summary> Response Unmarshaller for GetDeployment operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetOnPremisesInstanceRequestMarshaller"> <summary> GetOnPremisesInstance Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GetOnPremisesInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for GetOnPremisesInstance operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GitHubLocationMarshaller"> <summary> GitHubLocation Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.GitHubLocationUnmarshaller"> <summary> Response Unmarshaller for GitHubLocation Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.InstanceInfoUnmarshaller"> <summary> Response Unmarshaller for InstanceInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.InstanceSummaryUnmarshaller"> <summary> Response Unmarshaller for InstanceSummary Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.LifecycleEventUnmarshaller"> <summary> Response Unmarshaller for LifecycleEvent Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListApplicationRevisionsRequestMarshaller"> <summary> ListApplicationRevisions Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListApplicationRevisionsResponseUnmarshaller"> <summary> Response Unmarshaller for ListApplicationRevisions operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListApplicationsRequestMarshaller"> <summary> ListApplications Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListApplicationsResponseUnmarshaller"> <summary> Response Unmarshaller for ListApplications operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentConfigsRequestMarshaller"> <summary> ListDeploymentConfigs Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentConfigsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDeploymentConfigs operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentGroupsRequestMarshaller"> <summary> ListDeploymentGroups Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDeploymentGroups operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentInstancesRequestMarshaller"> <summary> ListDeploymentInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for ListDeploymentInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentsRequestMarshaller"> <summary> ListDeployments Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListDeploymentsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDeployments operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListOnPremisesInstancesRequestMarshaller"> <summary> ListOnPremisesInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.ListOnPremisesInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for ListOnPremisesInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.MinimumHealthyHostsMarshaller"> <summary> MinimumHealthyHosts Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.MinimumHealthyHostsUnmarshaller"> <summary> Response Unmarshaller for MinimumHealthyHosts Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RegisterApplicationRevisionRequestMarshaller"> <summary> RegisterApplicationRevision Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RegisterApplicationRevisionResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterApplicationRevision operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RegisterOnPremisesInstanceRequestMarshaller"> <summary> RegisterOnPremisesInstance Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RegisterOnPremisesInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterOnPremisesInstance operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RemoveTagsFromOnPremisesInstancesRequestMarshaller"> <summary> RemoveTagsFromOnPremisesInstances Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RemoveTagsFromOnPremisesInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for RemoveTagsFromOnPremisesInstances operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RevisionInfoUnmarshaller"> <summary> Response Unmarshaller for RevisionInfo Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RevisionLocationMarshaller"> <summary> RevisionLocation Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.RevisionLocationUnmarshaller"> <summary> Response Unmarshaller for RevisionLocation Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.S3LocationMarshaller"> <summary> S3Location Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.S3LocationUnmarshaller"> <summary> Response Unmarshaller for S3Location Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.StopDeploymentRequestMarshaller"> <summary> StopDeployment Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.StopDeploymentResponseUnmarshaller"> <summary> Response Unmarshaller for StopDeployment operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TagFilterMarshaller"> <summary> TagFilter Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TagFilterUnmarshaller"> <summary> Response Unmarshaller for TagFilter Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TagMarshaller"> <summary> Tag Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TimeRangeMarshaller"> <summary> TimeRange Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TriggerConfigMarshaller"> <summary> TriggerConfig Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.TriggerConfigUnmarshaller"> <summary> Response Unmarshaller for TriggerConfig Object </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.UpdateApplicationRequestMarshaller"> <summary> UpdateApplication Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.UpdateApplicationResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateApplication operation </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.UpdateDeploymentGroupRequestMarshaller"> <summary> UpdateDeploymentGroup Request Marshaller </summary> </member> <member name="T:Amazon.CodeDeploy.Model.Internal.MarshallTransformations.UpdateDeploymentGroupResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateDeploymentGroup operation </summary> </member> <member name="T:Amazon.CodeCommit.AmazonCodeCommitClient"> <summary> Implementation for accessing CodeCommit AWS CodeCommit <para> This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the AWS CodeCommit API. </para> <para> You can use the AWS CodeCommit API to work with the following objects: </para> <ul> <li>Repositories</li> <li>Branches</li> <li>Commits</li> </ul> <para> For information about how to use AWS CodeCommit, see the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="T:Amazon.CodeCommit.IAmazonCodeCommit"> <summary> Interface for accessing CodeCommit AWS CodeCommit <para> This is the <i>AWS CodeCommit API Reference</i>. This reference provides descriptions of the AWS CodeCommit API. </para> <para> You can use the AWS CodeCommit API to work with the following objects: </para> <ul> <li>Repositories</li> <li>Branches</li> <li>Commits</li> </ul> <para> For information about how to use AWS CodeCommit, see the <i>AWS CodeCommit User Guide</i>. </para> </summary> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest)"> <summary> Gets information about one or more repositories. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories service method.</param> <returns>The response from the BatchGetRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException"> The maximum number of allowed repository names was exceeded. Currently, this number is 25. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNamesRequiredException"> A repository names object is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginBatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetRepositories operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndBatchGetRepositories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetRepositories.</param> <returns>Returns a BatchGetRepositoriesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest)"> <summary> Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch service method.</param> <returns>The response from the CreateBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchNameExistsException"> The specified branch name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitDoesNotExistException"> The specified commit does not exist or no commit was specified, and the specified repository has no default branch. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitIdRequiredException"> A commit ID was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidCommitIdException"> The specified commit ID is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginCreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndCreateBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateBranch.</param> <returns>Returns a CreateBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.CreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest)"> <summary> Creates a new, empty repository. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository service method.</param> <returns>The response from the CreateRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryLimitExceededException"> A repository resource limit was exceeded. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginCreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndCreateRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRepository.</param> <returns>Returns a CreateRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.DeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest)"> <summary> Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository service method.</param> <returns>The response from the DeleteRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginDeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndDeleteRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRepository.</param> <returns>Returns a DeleteRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetBranch(Amazon.CodeCommit.Model.GetBranchRequest)"> <summary> Retrieves information about a repository branch, including its name and the last commit ID. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch service method.</param> <returns>The response from the GetBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginGetBranch(Amazon.CodeCommit.Model.GetBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndGetBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBranch.</param> <returns>Returns a GetBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.GetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest)"> <summary> Gets information about a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRepository service method.</param> <returns>The response from the GetRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginGetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndGetRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRepository.</param> <returns>Returns a GetRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListBranches(Amazon.CodeCommit.Model.ListBranchesRequest)"> <summary> Gets information about one or more branches in a repository. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches service method.</param> <returns>The response from the ListBranches service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginListBranches(Amazon.CodeCommit.Model.ListBranchesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListBranches operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBranches operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndListBranches(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListBranches operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListBranches.</param> <returns>Returns a ListBranchesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.ListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest)"> <summary> Gets information about one or more repositories. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories service method.</param> <returns>The response from the ListRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidOrderException"> The specified sort order is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidSortByException"> The specified sort by value is not valid. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRepositories operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndListRepositories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRepositories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRepositories.</param> <returns>Returns a ListRepositoriesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest)"> <summary> Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch service method.</param> <returns>The response from the UpdateDefaultBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginUpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDefaultBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndUpdateDefaultBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultBranch.</param> <returns>Returns a UpdateDefaultBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest)"> <summary> Sets or changes the comment or description for a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription service method.</param> <returns>The response from the UpdateRepositoryDescription service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginUpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRepositoryDescription operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndUpdateRepositoryDescription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRepositoryDescription.</param> <returns>Returns a UpdateRepositoryDescriptionResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.UpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest)"> <summary> Renames a repository. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName service method.</param> <returns>The response from the UpdateRepositoryName service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.BeginUpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRepositoryName operation.</returns> </member> <member name="M:Amazon.CodeCommit.IAmazonCodeCommit.EndUpdateRepositoryName(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRepositoryName.</param> <returns>Returns a UpdateRepositoryNameResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Credentials and an AmazonCodeCommitClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.#ctor(System.String,System.String,System.String,Amazon.CodeCommit.AmazonCodeCommitConfig)"> <summary> Constructs AmazonCodeCommitClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeCommitClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodeCommitClient Configuration Object</param> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest)"> <summary> Gets information about one or more repositories. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories service method.</param> <returns>The response from the BatchGetRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException"> The maximum number of allowed repository names was exceeded. Currently, this number is 25. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNamesRequiredException"> A repository names object is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginBatchGetRepositories(Amazon.CodeCommit.Model.BatchGetRepositoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetRepositories operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBatchGetRepositories operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndBatchGetRepositories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetRepositories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetRepositories.</param> <returns>Returns a BatchGetRepositoriesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest)"> <summary> Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch service method.</param> <returns>The response from the CreateBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchNameExistsException"> The specified branch name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitDoesNotExistException"> The specified commit does not exist or no commit was specified, and the specified repository has no default branch. </exception> <exception cref="T:Amazon.CodeCommit.Model.CommitIdRequiredException"> A commit ID was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidCommitIdException"> The specified commit ID is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginCreateBranch(Amazon.CodeCommit.Model.CreateBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndCreateBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateBranch.</param> <returns>Returns a CreateBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.CreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest)"> <summary> Creates a new, empty repository. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository service method.</param> <returns>The response from the CreateRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryLimitExceededException"> A repository resource limit was exceeded. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginCreateRepository(Amazon.CodeCommit.Model.CreateRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndCreateRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRepository.</param> <returns>Returns a CreateRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.DeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest)"> <summary> Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository service method.</param> <returns>The response from the DeleteRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginDeleteRepository(Amazon.CodeCommit.Model.DeleteRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndDeleteRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRepository.</param> <returns>Returns a DeleteRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetBranch(Amazon.CodeCommit.Model.GetBranchRequest)"> <summary> Retrieves information about a repository branch, including its name and the last commit ID. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch service method.</param> <returns>The response from the GetBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginGetBranch(Amazon.CodeCommit.Model.GetBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndGetBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBranch.</param> <returns>Returns a GetBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.GetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest)"> <summary> Gets information about a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRepository service method.</param> <returns>The response from the GetRepository service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginGetRepository(Amazon.CodeCommit.Model.GetRepositoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRepository operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRepository operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRepository operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndGetRepository(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRepository operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRepository.</param> <returns>Returns a GetRepositoryResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListBranches(Amazon.CodeCommit.Model.ListBranchesRequest)"> <summary> Gets information about one or more branches in a repository. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches service method.</param> <returns>The response from the ListBranches service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginListBranches(Amazon.CodeCommit.Model.ListBranchesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListBranches operation. </summary> <param name="request">Container for the necessary parameters to execute the ListBranches operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListBranches operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndListBranches(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListBranches operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListBranches.</param> <returns>Returns a ListBranchesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.ListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest)"> <summary> Gets information about one or more repositories. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories service method.</param> <returns>The response from the ListRepositories service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> The specified continuation token is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidOrderException"> The specified sort order is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidSortByException"> The specified sort by value is not valid. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginListRepositories(Amazon.CodeCommit.Model.ListRepositoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRepositories operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRepositories operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRepositories operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndListRepositories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRepositories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRepositories.</param> <returns>Returns a ListRepositoriesResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest)"> <summary> Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch service method.</param> <returns>The response from the UpdateDefaultBranch service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> The specified branch does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> A branch name is required but was not specified. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> The specified branch name is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginUpdateDefaultBranch(Amazon.CodeCommit.Model.UpdateDefaultBranchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultBranch operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDefaultBranch operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndUpdateDefaultBranch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDefaultBranch operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultBranch.</param> <returns>Returns a UpdateDefaultBranchResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest)"> <summary> Sets or changes the comment or description for a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription service method.</param> <returns>The response from the UpdateRepositoryDescription service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> An encryption integrity check failed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> An encryption key could not be accessed. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> The encryption key is disabled. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> No encryption key was found. </exception> <exception cref="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> The encryption key is not available. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> The specified repository description is not valid. </exception> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginUpdateRepositoryDescription(Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryDescription operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRepositoryDescription operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndUpdateRepositoryDescription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRepositoryDescription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRepositoryDescription.</param> <returns>Returns a UpdateRepositoryDescriptionResult from CodeCommit.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.UpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest)"> <summary> Renames a repository. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName service method.</param> <returns>The response from the UpdateRepositoryName service method, as returned by CodeCommit.</returns> <exception cref="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> At least one specified repository name is not valid. <note>This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.</note> </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> The specified repository does not exist. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> The specified repository name already exists. </exception> <exception cref="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> A repository name is required but was not specified. </exception> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.BeginUpdateRepositoryName(Amazon.CodeCommit.Model.UpdateRepositoryNameRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRepositoryName operation on AmazonCodeCommitClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRepositoryName operation.</returns> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitClient.EndUpdateRepositoryName(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRepositoryName operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRepositoryName.</param> <returns>Returns a UpdateRepositoryNameResult from CodeCommit.</returns> </member> <member name="T:Amazon.CodeCommit.AmazonCodeCommitConfig"> <summary> Configuration for accessing Amazon CodeCommit service </summary> </member> <member name="M:Amazon.CodeCommit.AmazonCodeCommitConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CodeCommit.AmazonCodeCommitConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CodeCommit.AmazonCodeCommitConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CodeCommit.OrderEnum"> <summary> Constants used for properties of type OrderEnum. </summary> </member> <member name="F:Amazon.CodeCommit.OrderEnum.Ascending"> <summary> Constant Ascending for OrderEnum </summary> </member> <member name="F:Amazon.CodeCommit.OrderEnum.Descending"> <summary> Constant Descending for OrderEnum </summary> </member> <member name="M:Amazon.CodeCommit.OrderEnum.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeCommit.OrderEnum.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeCommit.SortByEnum"> <summary> Constants used for properties of type SortByEnum. </summary> </member> <member name="F:Amazon.CodeCommit.SortByEnum.LastModifiedDate"> <summary> Constant LastModifiedDate for SortByEnum </summary> </member> <member name="F:Amazon.CodeCommit.SortByEnum.RepositoryName"> <summary> Constant RepositoryName for SortByEnum </summary> </member> <member name="M:Amazon.CodeCommit.SortByEnum.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodeCommit.SortByEnum.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodeCommit.AmazonCodeCommitRequest"> <summary> Base class for CodeCommit operation requests. </summary> </member> <member name="T:Amazon.CodeCommit.Model.BatchGetRepositoriesRequest"> <summary> Container for the parameters to the BatchGetRepositories operation. Gets information about one or more repositories. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.BatchGetRepositoriesRequest.RepositoryNames"> <summary> Gets and sets the property RepositoryNames. <para> The names of the repositories to get information about. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.BatchGetRepositoriesResponse"> <summary> Configuration for accessing Amazon BatchGetRepositories service </summary> </member> <member name="T:Amazon.CodeCommit.Model.BatchGetRepositoriesResult"> <summary> Represents the output of a batch get repositories operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.BatchGetRepositoriesResult.Repositories"> <summary> Gets and sets the property Repositories. <para> A list of repositories returned by the batch get repositories operation. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.BatchGetRepositoriesResult.RepositoriesNotFound"> <summary> Gets and sets the property RepositoriesNotFound. <para> Returns a list of repository names for which information could not be found. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.BatchGetRepositoriesResponse.BatchGetRepositoriesResult"> <summary> Gets and sets the BatchGetRepositoriesResult property. Represents the output of a BatchGetRepositories operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.BranchDoesNotExistException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.BranchDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new BranchDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.BranchInfo"> <summary> Returns information about a branch. </summary> </member> <member name="P:Amazon.CodeCommit.Model.BranchInfo.BranchName"> <summary> Gets and sets the property BranchName. <para> The name of the branch. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.BranchInfo.CommitId"> <summary> Gets and sets the property CommitId. <para> The ID of the last commit made to the branch. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.BranchNameExistsException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.BranchNameExistsException.#ctor(System.String)"> <summary> Constructs a new BranchNameExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.BranchNameRequiredException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.BranchNameRequiredException.#ctor(System.String)"> <summary> Constructs a new BranchNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.CommitDoesNotExistException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.CommitDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new CommitDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.CommitIdRequiredException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.CommitIdRequiredException.#ctor(System.String)"> <summary> Constructs a new CommitIdRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.CreateBranchRequest"> <summary> Container for the parameters to the CreateBranch operation. Creates a new branch in a repository and points the branch to a commit. <note>Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.</note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateBranchRequest.BranchName"> <summary> Gets and sets the property BranchName. <para> The name of the new branch to create. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateBranchRequest.CommitId"> <summary> Gets and sets the property CommitId. <para> The ID of the commit to point the new branch to. </para> <note>If this commit ID is not specified, the new branch will point to the commit that is pointed to by the repository's default branch.</note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateBranchRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository in which you want to create the new branch. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.CreateRepositoryRequest"> <summary> Container for the parameters to the CreateRepository operation. Creates a new, empty repository. </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateRepositoryRequest.RepositoryDescription"> <summary> Gets and sets the property RepositoryDescription. <para> A comment or description about the new repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateRepositoryRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the new repository to be created. </para> <note>The repository name must be unique across the calling AWS account. In addition, repository names are restricted to alphanumeric characters. The suffix ".git" is prohibited.</note> </summary> </member> <member name="T:Amazon.CodeCommit.Model.CreateRepositoryResponse"> <summary> Configuration for accessing Amazon CreateRepository service </summary> </member> <member name="T:Amazon.CodeCommit.Model.CreateRepositoryResult"> <summary> Represents the output of a create repository operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateRepositoryResult.RepositoryMetadata"> <summary> Gets and sets the property RepositoryMetadata. <para> Information about the newly created repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.CreateRepositoryResponse.CreateRepositoryResult"> <summary> Gets and sets the CreateRepositoryResult property. Represents the output of a CreateRepository operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.DeleteRepositoryRequest"> <summary> Container for the parameters to the DeleteRepository operation. Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned. <important>Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.</important> </summary> </member> <member name="P:Amazon.CodeCommit.Model.DeleteRepositoryRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository to delete. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.DeleteRepositoryResponse"> <summary> Configuration for accessing Amazon DeleteRepository service </summary> </member> <member name="T:Amazon.CodeCommit.Model.DeleteRepositoryResult"> <summary> Represents the output of a delete repository operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.DeleteRepositoryResult.RepositoryId"> <summary> Gets and sets the property RepositoryId. <para> The ID of the repository that was deleted. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.DeleteRepositoryResponse.DeleteRepositoryResult"> <summary> Gets and sets the DeleteRepositoryResult property. Represents the output of a DeleteRepository operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.EncryptionIntegrityChecksFailedException.#ctor(System.String)"> <summary> Constructs a new EncryptionIntegrityChecksFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.EncryptionKeyAccessDeniedException.#ctor(System.String)"> <summary> Constructs a new EncryptionKeyAccessDeniedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.EncryptionKeyDisabledException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.EncryptionKeyDisabledException.#ctor(System.String)"> <summary> Constructs a new EncryptionKeyDisabledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.EncryptionKeyNotFoundException.#ctor(System.String)"> <summary> Constructs a new EncryptionKeyNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.EncryptionKeyUnavailableException.#ctor(System.String)"> <summary> Constructs a new EncryptionKeyUnavailableException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.GetBranchRequest"> <summary> Container for the parameters to the GetBranch operation. Retrieves information about a repository branch, including its name and the last commit ID. </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetBranchRequest.BranchName"> <summary> Gets and sets the property BranchName. <para> The name of the branch for which you want to retrieve information. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetBranchRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. </summary> </member> <member name="T:Amazon.CodeCommit.Model.GetBranchResponse"> <summary> Configuration for accessing Amazon GetBranch service </summary> </member> <member name="T:Amazon.CodeCommit.Model.GetBranchResult"> <summary> Represents the output of a get branch operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetBranchResult.Branch"> <summary> Gets and sets the property Branch. <para> The name of the branch. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetBranchResponse.GetBranchResult"> <summary> Gets and sets the GetBranchResult property. Represents the output of a GetBranch operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.GetRepositoryRequest"> <summary> Container for the parameters to the GetRepository operation. Gets information about a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetRepositoryRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository to get information about. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.GetRepositoryResponse"> <summary> Configuration for accessing Amazon GetRepository service </summary> </member> <member name="T:Amazon.CodeCommit.Model.GetRepositoryResult"> <summary> Represents the output of a get repository operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetRepositoryResult.RepositoryMetadata"> <summary> Gets and sets the property RepositoryMetadata. <para> Information about the repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.GetRepositoryResponse.GetRepositoryResult"> <summary> Gets and sets the GetRepositoryResult property. Represents the output of a GetRepository operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.InvalidBranchNameException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidBranchNameException.#ctor(System.String)"> <summary> Constructs a new InvalidBranchNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidCommitIdException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidCommitIdException.#ctor(System.String)"> <summary> Constructs a new InvalidCommitIdException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidContinuationTokenException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidContinuationTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidContinuationTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidOrderException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidOrderException.#ctor(System.String)"> <summary> Constructs a new InvalidOrderException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidRepositoryDescriptionException.#ctor(System.String)"> <summary> Constructs a new InvalidRepositoryDescriptionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidRepositoryNameException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidRepositoryNameException.#ctor(System.String)"> <summary> Constructs a new InvalidRepositoryNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.InvalidSortByException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.InvalidSortByException.#ctor(System.String)"> <summary> Constructs a new InvalidSortByException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.ListBranchesRequest"> <summary> Container for the parameters to the ListBranches operation. Gets information about one or more branches in a repository. </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListBranchesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An enumeration token that allows the operation to batch the results. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListBranchesRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository that contains the branches. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.ListBranchesResponse"> <summary> Configuration for accessing Amazon ListBranches service </summary> </member> <member name="T:Amazon.CodeCommit.Model.ListBranchesResult"> <summary> Represents the output of a list branches operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListBranchesResult.Branches"> <summary> Gets and sets the property Branches. <para> The list of branch names. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListBranchesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> An enumeration token that returns the batch of the results. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListBranchesResponse.ListBranchesResult"> <summary> Gets and sets the ListBranchesResult property. Represents the output of a ListBranches operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.ListRepositoriesRequest"> <summary> Container for the parameters to the ListRepositories operation. Gets information about one or more repositories. </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesRequest.Order"> <summary> Gets and sets the property Order. <para> The order in which to sort the results of a list repositories operation. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesRequest.SortBy"> <summary> Gets and sets the property SortBy. <para> The criteria used to sort the results of a list repositories operation. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.ListRepositoriesResponse"> <summary> Configuration for accessing Amazon ListRepositories service </summary> </member> <member name="T:Amazon.CodeCommit.Model.ListRepositoriesResult"> <summary> Represents the output of a list repositories operation. </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesResult.Repositories"> <summary> Gets and sets the property Repositories. <para> Lists the repositories called by the list repositories operation. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.ListRepositoriesResponse.ListRepositoriesResult"> <summary> Gets and sets the ListRepositoriesResult property. Represents the output of a ListRepositories operation. </summary> </member> <member name="T:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.MaximumRepositoryNamesExceededException.#ctor(System.String)"> <summary> Constructs a new MaximumRepositoryNamesExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryDoesNotExistException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.RepositoryDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new RepositoryDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryLimitExceededException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.RepositoryLimitExceededException.#ctor(System.String)"> <summary> Constructs a new RepositoryLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryMetadata"> <summary> Information about a repository. </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.AccountId"> <summary> Gets and sets the property AccountId. <para> The ID of the AWS account associated with the repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.CloneUrlHttp"> <summary> Gets and sets the property CloneUrlHttp. <para> The URL to use for cloning the repository over HTTPS. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.CloneUrlSsh"> <summary> Gets and sets the property CloneUrlSsh. <para> The URL to use for cloning the repository over SSH. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.CreationDate"> <summary> Gets and sets the property CreationDate. <para> The date and time the repository was created, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.DefaultBranch"> <summary> Gets and sets the property DefaultBranch. <para> The repository's default branch name. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. <para> The date and time the repository was last modified, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.RepositoryDescription"> <summary> Gets and sets the property RepositoryDescription. <para> A comment or description about the repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.RepositoryId"> <summary> Gets and sets the property RepositoryId. <para> The ID of the repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryMetadata.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The repository's name. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryNameExistsException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.RepositoryNameExistsException.#ctor(System.String)"> <summary> Constructs a new RepositoryNameExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryNameIdPair"> <summary> Information about a repository name and ID. </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryNameIdPair.RepositoryId"> <summary> Gets and sets the property RepositoryId. <para> The ID associated with the repository name. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.RepositoryNameIdPair.RepositoryName"> <summary> Gets and sets the property RepositoryName. </summary> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryNameRequiredException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.RepositoryNameRequiredException.#ctor(System.String)"> <summary> Constructs a new RepositoryNameRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.RepositoryNamesRequiredException"> <summary> CodeCommit exception </summary> </member> <member name="M:Amazon.CodeCommit.Model.RepositoryNamesRequiredException.#ctor(System.String)"> <summary> Constructs a new RepositoryNamesRequiredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodeCommit.Model.UpdateDefaultBranchRequest"> <summary> Container for the parameters to the UpdateDefaultBranch operation. Sets or changes the default branch name for the specified repository. <note>If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.</note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateDefaultBranchRequest.DefaultBranchName"> <summary> Gets and sets the property DefaultBranchName. <para> The name of the branch to set as the default. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateDefaultBranchRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository to set or change the default branch for. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest"> <summary> Container for the parameters to the UpdateRepositoryDescription operation. Sets or changes the comment or description for a repository. <note> <para> The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page. </para> </note> </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest.RepositoryDescription"> <summary> Gets and sets the property RepositoryDescription. <para> The new comment or description for the specified repository. </para> </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateRepositoryDescriptionRequest.RepositoryName"> <summary> Gets and sets the property RepositoryName. <para> The name of the repository to set or change the comment or description for. </para> </summary> </member> <member name="T:Amazon.CodeCommit.Model.UpdateRepositoryNameRequest"> <summary> Container for the parameters to the UpdateRepositoryName operation. Renames a repository. </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateRepositoryNameRequest.NewName"> <summary> Gets and sets the property NewName. </summary> </member> <member name="P:Amazon.CodeCommit.Model.UpdateRepositoryNameRequest.OldName"> <summary> Gets and sets the property OldName. </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.BatchGetRepositoriesRequestMarshaller"> <summary> BatchGetRepositories Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.BatchGetRepositoriesResponseUnmarshaller"> <summary> Response Unmarshaller for BatchGetRepositories operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.BranchInfoUnmarshaller"> <summary> Response Unmarshaller for BranchInfo Object </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.CreateBranchRequestMarshaller"> <summary> CreateBranch Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.CreateBranchResponseUnmarshaller"> <summary> Response Unmarshaller for CreateBranch operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.CreateRepositoryRequestMarshaller"> <summary> CreateRepository Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.CreateRepositoryResponseUnmarshaller"> <summary> Response Unmarshaller for CreateRepository operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.DeleteRepositoryRequestMarshaller"> <summary> DeleteRepository Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.DeleteRepositoryResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRepository operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.GetBranchRequestMarshaller"> <summary> GetBranch Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.GetBranchResponseUnmarshaller"> <summary> Response Unmarshaller for GetBranch operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.GetRepositoryRequestMarshaller"> <summary> GetRepository Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.GetRepositoryResponseUnmarshaller"> <summary> Response Unmarshaller for GetRepository operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.ListBranchesRequestMarshaller"> <summary> ListBranches Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.ListBranchesResponseUnmarshaller"> <summary> Response Unmarshaller for ListBranches operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.ListRepositoriesRequestMarshaller"> <summary> ListRepositories Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.ListRepositoriesResponseUnmarshaller"> <summary> Response Unmarshaller for ListRepositories operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.RepositoryMetadataUnmarshaller"> <summary> Response Unmarshaller for RepositoryMetadata Object </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.RepositoryNameIdPairUnmarshaller"> <summary> Response Unmarshaller for RepositoryNameIdPair Object </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateDefaultBranchRequestMarshaller"> <summary> UpdateDefaultBranch Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateDefaultBranchResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateDefaultBranch operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateRepositoryDescriptionRequestMarshaller"> <summary> UpdateRepositoryDescription Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateRepositoryDescriptionResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateRepositoryDescription operation </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateRepositoryNameRequestMarshaller"> <summary> UpdateRepositoryName Request Marshaller </summary> </member> <member name="T:Amazon.CodeCommit.Model.Internal.MarshallTransformations.UpdateRepositoryNameResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateRepositoryName operation </summary> </member> <member name="T:Amazon.CodePipeline.AmazonCodePipelineClient"> <summary> Implementation for accessing CodePipeline AWS CodePipeline <b>Overview</b> <para> This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the <a href="http://docs.aws.amazon.com/pipelines/latest/userguide/welcome.html">AWS CodePipeline User Guide</a>. </para> <para> You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below. </para> <para> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages. </para> <para> You can work with pipelines by calling: <ul> <li> <a>CreatePipeline</a>, which creates a uniquely-named pipeline.</li> <li> <a>DeletePipeline</a>, which deletes the specified pipeline.</li> <li> <a>GetPipeline</a>, which returns information about a pipeline structure.</li> <li> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</li> <li> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</li> <li> <a>StartPipelineExecution</a>, which runs the the most recent revision of an artifact through the pipeline.</li> <li> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</li> </ul> <para> Pipelines include <i>stages</i>, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the <ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html">AWS CodePipeline Pipeline Structure Reference</ulink>. </para> </para> <para> Pipeline stages include <i>actions</i>, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. </para> <para> Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete. </para> <para> You can work with transitions by calling: </para> <ul> <li> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</li> <li> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </li> </ul> <para> <b>Using the API to integrate with AWS CodePipeline</b> </para> <para> For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items: </para> <ul> <li>Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. <para> You can work with jobs by calling: </para> <ul> <li> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetJobDetails</a>, which returns the details of a job,</li> <li> <a>PollForJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> <li>Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network. <para> You can work with third party jobs by calling: </para> <ul> <li> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action,</li> <li> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> </ul> </summary> </member> <member name="T:Amazon.CodePipeline.IAmazonCodePipeline"> <summary> Interface for accessing CodePipeline AWS CodePipeline <b>Overview</b> <para> This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the <a href="http://docs.aws.amazon.com/pipelines/latest/userguide/welcome.html">AWS CodePipeline User Guide</a>. </para> <para> You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below. </para> <para> <i>Pipelines</i> are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages. </para> <para> You can work with pipelines by calling: <ul> <li> <a>CreatePipeline</a>, which creates a uniquely-named pipeline.</li> <li> <a>DeletePipeline</a>, which deletes the specified pipeline.</li> <li> <a>GetPipeline</a>, which returns information about a pipeline structure.</li> <li> <a>GetPipelineState</a>, which returns information about the current state of the stages and actions of a pipeline.</li> <li> <a>ListPipelines</a>, which gets a summary of all of the pipelines associated with your account.</li> <li> <a>StartPipelineExecution</a>, which runs the the most recent revision of an artifact through the pipeline.</li> <li> <a>UpdatePipeline</a>, which updates a pipeline with edits or changes to the structure of the pipeline.</li> </ul> <para> Pipelines include <i>stages</i>, which are which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call <a>GetPipelineState</a>, which displays the status of a pipeline, including the status of stages in the pipeline, or <a>GetPipeline</a>, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the <ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/pipeline-structure.html">AWS CodePipeline Pipeline Structure Reference</ulink>. </para> </para> <para> Pipeline stages include <i>actions</i>, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as <a>CreatePipeline</a> and <a>GetPipelineState</a>. </para> <para> Pipelines also include <i>transitions</i>, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete. </para> <para> You can work with transitions by calling: </para> <ul> <li> <a>DisableStageTransition</a>, which prevents artifacts from transitioning to the next stage in a pipeline.</li> <li> <a>EnableStageTransition</a>, which enables transition of artifacts between stages in a pipeline. </li> </ul> <para> <b>Using the API to integrate with AWS CodePipeline</b> </para> <para> For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items: </para> <ul> <li>Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source. <para> You can work with jobs by calling: </para> <ul> <li> <a>AcknowledgeJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetJobDetails</a>, which returns the details of a job,</li> <li> <a>PollForJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> <li>Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network. <para> You can work with third party jobs by calling: </para> <ul> <li> <a>AcknowledgeThirdPartyJob</a>, which confirms whether a job worker has received the specified job,</li> <li> <a>GetThirdPartyJobDetails</a>, which requests the details of a job for a partner action,</li> <li> <a>PollForThirdPartyJobs</a>, which determines whether there are any jobs to act upon, </li> <li> <a>PutThirdPartyJobFailureResult</a>, which provides details of a job failure, and</li> <li> <a>PutThirdPartyJobSuccessResult</a>, which provides details of a job success.</li> </ul> </li> </ul> </summary> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeJob(System.String,System.String)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job for which you want to confirm receipt.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob service method.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginAcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcknowledgeJob operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndAcknowledgeJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcknowledgeJob.</param> <returns>Returns a AcknowledgeJobResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeThirdPartyJob(System.String,System.String,System.String)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID of the job.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.AcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob service method.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginAcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcknowledgeThirdPartyJob operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndAcknowledgeThirdPartyJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcknowledgeThirdPartyJob.</param> <returns>Returns a AcknowledgeThirdPartyJobResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest)"> <summary> Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType service method.</param> <returns>The response from the CreateCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginCreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCustomActionType operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndCreateCustomActionType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCustomActionType.</param> <returns>Returns a CreateCustomActionTypeResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Creates a pipeline. </summary> <param name="pipeline">A property of CreatePipelineRequest used to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.CreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest)"> <summary> Creates a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginCreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.IAmazonCodePipeline.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest)"> <summary> Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important> <para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType service method.</param> <returns>The response from the DeleteCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginDeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCustomActionType operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndDeleteCustomActionType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCustomActionType.</param> <returns>Returns a DeleteCustomActionTypeResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeletePipeline(System.String)"> <summary> Deletes the specified pipeline. </summary> <param name="name">The name of the pipeline to be deleted.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest)"> <summary> Deletes the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginDeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.IAmazonCodePipeline.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.DisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest)"> <summary> Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition service method.</param> <returns>The response from the DisableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginDisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableStageTransition operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndDisableStageTransition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableStageTransition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableStageTransition.</param> <returns>Returns a DisableStageTransitionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest)"> <summary> Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition service method.</param> <returns>The response from the EnableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginEnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableStageTransition operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndEnableStageTransition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableStageTransition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableStageTransition.</param> <returns>Returns a EnableStageTransitionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetJobDetails(System.String)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="jobId">The unique system-generated ID for the job.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails service method.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginGetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobDetails operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndGetJobDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJobDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJobDetails.</param> <returns>Returns a GetJobDetailsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(System.String,System.Int32)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <param name="version">The version number of the pipeline. If you do not specify a version, defaults to the most current version.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(System.String)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline service method.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginGetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipeline operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndGetPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipeline.</param> <returns>Returns a GetPipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineState(System.String)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="name">The name of the pipeline about which you want to get information.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState service method.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginGetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineState operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineState operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndGetPipelineState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipelineState operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineState.</param> <returns>Returns a GetPipelineStateResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetThirdPartyJobDetails(System.String,System.String)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID used for identifying the job.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.GetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails service method.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginGetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetThirdPartyJobDetails operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndGetThirdPartyJobDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetThirdPartyJobDetails.</param> <returns>Returns a GetThirdPartyJobDetailsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes(Amazon.CodePipeline.ActionOwner)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="actionOwnerFilter">Filters the list of action types to those created by a specified entity.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes service method.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListActionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListActionTypes operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndListActionTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListActionTypes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListActionTypes.</param> <returns>Returns a ListActionTypesResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListPipelines"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.ListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest)"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.IAmazonCodePipeline.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest)"> <summary> Returns information about any jobs for AWS CodePipeline to act upon. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs service method.</param> <returns>The response from the PollForJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForJobs operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPollForJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForJobs.</param> <returns>Returns a PollForJobsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest)"> <summary> Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs service method.</param> <returns>The response from the PollForThirdPartyJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForThirdPartyJobs operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPollForThirdPartyJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForThirdPartyJobs.</param> <returns>Returns a PollForThirdPartyJobsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest)"> <summary> Provides information to AWS CodePipeline about new revisions to a source. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision service method.</param> <returns>The response from the PutActionRevision service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionNotFoundException"> The specified action cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutActionRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutActionRevision operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPutActionRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutActionRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutActionRevision.</param> <returns>Returns a PutActionRevisionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobFailureResult(System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.</param> <param name="failureDetails">The details about the failure of a job. </param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult service method.</param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutJobFailureResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPutJobFailureResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutJobFailureResult.</param> <returns>Returns a PutJobFailureResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest)"> <summary> Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult service method.</param> <returns>The response from the PutJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutJobSuccessResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPutJobSuccessResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutJobSuccessResult.</param> <returns>Returns a PutJobSuccessResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobFailureResult(System.String,System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="jobId">The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</param> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="failureDetails">A property of PutThirdPartyJobFailureResultRequest used to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutThirdPartyJobFailureResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPutThirdPartyJobFailureResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutThirdPartyJobFailureResult.</param> <returns>Returns a PutThirdPartyJobFailureResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.PutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest)"> <summary> Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult service method.</param> <returns>The response from the PutThirdPartyJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginPutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutThirdPartyJobSuccessResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndPutThirdPartyJobSuccessResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutThirdPartyJobSuccessResult.</param> <returns>Returns a PutThirdPartyJobSuccessResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.StartPipelineExecution(System.String)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="name">The name of the pipeline to start.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.StartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution service method.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginStartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPipelineExecution operation.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.EndStartPipelineExecution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartPipelineExecution.</param> <returns>Returns a StartPipelineExecutionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.UpdatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="pipeline">The name of the pipeline to be updated.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.UpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.IAmazonCodePipeline.BeginUpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.IAmazonCodePipeline.EndUpdatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipeline.</param> <returns>Returns a UpdatePipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Credentials and an AmazonCodePipelineClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.#ctor(System.String,System.String,System.String,Amazon.CodePipeline.AmazonCodePipelineConfig)"> <summary> Constructs AmazonCodePipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonCodePipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCodePipelineClient Configuration Object</param> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeJob(System.String,System.String)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job for which you want to confirm receipt.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest)"> <summary> Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob service method.</param> <returns>The response from the AcknowledgeJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginAcknowledgeJob(Amazon.CodePipeline.Model.AcknowledgeJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeJob operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcknowledgeJob operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndAcknowledgeJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcknowledgeJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcknowledgeJob.</param> <returns>Returns a AcknowledgeJobResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeThirdPartyJob(System.String,System.String,System.String)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID of the job.</param> <param name="nonce">A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.AcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest)"> <summary> Confirms a job worker has received the specified job. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob service method.</param> <returns>The response from the AcknowledgeThirdPartyJob service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidNonceException"> The specified nonce was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginAcknowledgeThirdPartyJob(Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="request">Container for the necessary parameters to execute the AcknowledgeThirdPartyJob operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcknowledgeThirdPartyJob operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndAcknowledgeThirdPartyJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcknowledgeThirdPartyJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcknowledgeThirdPartyJob.</param> <returns>Returns a AcknowledgeThirdPartyJobResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest)"> <summary> Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType service method.</param> <returns>The response from the CreateCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginCreateCustomActionType(Amazon.CodePipeline.Model.CreateCustomActionTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomActionType operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCustomActionType operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndCreateCustomActionType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCustomActionType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCustomActionType.</param> <returns>Returns a CreateCustomActionTypeResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Creates a pipeline. </summary> <param name="pipeline">A property of CreatePipelineRequest used to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.CreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest)"> <summary> Creates a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.LimitExceededException"> The number of pipelines associated with the AWS account has exceeded the limit allowed for the account. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> The specified pipeline name is already in use. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginCreatePipeline(Amazon.CodePipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.AmazonCodePipelineClient.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest)"> <summary> Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important> <para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType service method.</param> <returns>The response from the DeleteCustomActionType service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginDeleteCustomActionType(Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomActionType operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCustomActionType operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndDeleteCustomActionType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCustomActionType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCustomActionType.</param> <returns>Returns a DeleteCustomActionTypeResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeletePipeline(System.String)"> <summary> Deletes the specified pipeline. </summary> <param name="name">The name of the pipeline to be deleted.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest)"> <summary> Deletes the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginDeletePipeline(Amazon.CodePipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.AmazonCodePipelineClient.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.DisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest)"> <summary> Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition service method.</param> <returns>The response from the DisableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginDisableStageTransition(Amazon.CodePipeline.Model.DisableStageTransitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableStageTransition operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableStageTransition operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndDisableStageTransition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableStageTransition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableStageTransition.</param> <returns>Returns a DisableStageTransitionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest)"> <summary> Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition service method.</param> <returns>The response from the EnableStageTransition service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginEnableStageTransition(Amazon.CodePipeline.Model.EnableStageTransitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableStageTransition operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableStageTransition operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableStageTransition operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndEnableStageTransition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableStageTransition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableStageTransition.</param> <returns>Returns a EnableStageTransitionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetJobDetails(System.String)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="jobId">The unique system-generated ID for the job.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest)"> <summary> Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails service method.</param> <returns>The response from the GetJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginGetJobDetails(Amazon.CodePipeline.Model.GetJobDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJobDetails operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJobDetails operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndGetJobDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJobDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJobDetails.</param> <returns>Returns a GetJobDetailsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(System.String,System.Int32)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <param name="version">The version number of the pipeline. If you do not specify a version, defaults to the most current version.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(System.String)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="name">The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest)"> <summary> Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline service method.</param> <returns>The response from the GetPipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> The specified pipeline version was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginGetPipeline(Amazon.CodePipeline.Model.GetPipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipeline operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndGetPipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipeline.</param> <returns>Returns a GetPipelineResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineState(System.String)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="name">The name of the pipeline about which you want to get information.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest)"> <summary> Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState service method.</param> <returns>The response from the GetPipelineState service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginGetPipelineState(Amazon.CodePipeline.Model.GetPipelineStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineState operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineState operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPipelineState operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndGetPipelineState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipelineState operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineState.</param> <returns>Returns a GetPipelineStateResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetThirdPartyJobDetails(System.String,System.String)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="jobId">The unique system-generated ID used for identifying the job.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.GetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest)"> <summary> Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails service method.</param> <returns>The response from the GetThirdPartyJobDetails service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginGetThirdPartyJobDetails(Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetThirdPartyJobDetails operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetThirdPartyJobDetails operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndGetThirdPartyJobDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetThirdPartyJobDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetThirdPartyJobDetails.</param> <returns>Returns a GetThirdPartyJobDetailsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes(Amazon.CodePipeline.ActionOwner)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="actionOwnerFilter">Filters the list of action types to those created by a specified entity.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest)"> <summary> Gets a summary of all AWS CodePipeline action types associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes service method.</param> <returns>The response from the ListActionTypes service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginListActionTypes(Amazon.CodePipeline.Model.ListActionTypesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListActionTypes operation. </summary> <param name="request">Container for the necessary parameters to execute the ListActionTypes operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListActionTypes operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndListActionTypes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListActionTypes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListActionTypes.</param> <returns>Returns a ListActionTypesResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListPipelines"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.ListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest)"> <summary> Gets a summary of all of the pipelines associated with your account. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginListPipelines(Amazon.CodePipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.AmazonCodePipelineClient.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest)"> <summary> Returns information about any jobs for AWS CodePipeline to act upon. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs service method.</param> <returns>The response from the PollForJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPollForJobs(Amazon.CodePipeline.Model.PollForJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForJobs operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForJobs operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPollForJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForJobs.</param> <returns>Returns a PollForJobsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest)"> <summary> Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs service method.</param> <returns>The response from the PollForThirdPartyJobs service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> The specified action type cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPollForThirdPartyJobs(Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForThirdPartyJobs operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForThirdPartyJobs operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPollForThirdPartyJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForThirdPartyJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForThirdPartyJobs.</param> <returns>Returns a PollForThirdPartyJobsResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest)"> <summary> Provides information to AWS CodePipeline about new revisions to a source. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision service method.</param> <returns>The response from the PutActionRevision service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.ActionNotFoundException"> The specified action cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.StageNotFoundException"> The specified stage was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPutActionRevision(Amazon.CodePipeline.Model.PutActionRevisionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutActionRevision operation. </summary> <param name="request">Container for the necessary parameters to execute the PutActionRevision operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutActionRevision operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPutActionRevision(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutActionRevision operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutActionRevision.</param> <returns>Returns a PutActionRevisionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobFailureResult(System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="jobId">The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.</param> <param name="failureDetails">The details about the failure of a job. </param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest)"> <summary> Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult service method.</param> <returns>The response from the PutJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPutJobFailureResult(Amazon.CodePipeline.Model.PutJobFailureResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobFailureResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutJobFailureResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPutJobFailureResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutJobFailureResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutJobFailureResult.</param> <returns>Returns a PutJobFailureResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest)"> <summary> Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult service method.</param> <returns>The response from the PutJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPutJobSuccessResult(Amazon.CodePipeline.Model.PutJobSuccessResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutJobSuccessResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutJobSuccessResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPutJobSuccessResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutJobSuccessResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutJobSuccessResult.</param> <returns>Returns a PutJobSuccessResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobFailureResult(System.String,System.String,Amazon.CodePipeline.Model.FailureDetails)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="jobId">The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.</param> <param name="clientToken">The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</param> <param name="failureDetails">A property of PutThirdPartyJobFailureResultRequest used to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest)"> <summary> Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult service method.</param> <returns>The response from the PutThirdPartyJobFailureResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPutThirdPartyJobFailureResult(Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobFailureResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutThirdPartyJobFailureResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPutThirdPartyJobFailureResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutThirdPartyJobFailureResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutThirdPartyJobFailureResult.</param> <returns>Returns a PutThirdPartyJobFailureResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.PutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest)"> <summary> Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult service method.</param> <returns>The response from the PutThirdPartyJobSuccessResult service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> The client token was specified in an invalid format </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidJobStateException"> The specified job state was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.JobNotFoundException"> The specified job was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginPutThirdPartyJobSuccessResult(Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="request">Container for the necessary parameters to execute the PutThirdPartyJobSuccessResult operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutThirdPartyJobSuccessResult operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndPutThirdPartyJobSuccessResult(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutThirdPartyJobSuccessResult operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutThirdPartyJobSuccessResult.</param> <returns>Returns a PutThirdPartyJobSuccessResultResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.StartPipelineExecution(System.String)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="name">The name of the pipeline to start.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.StartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest)"> <summary> Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution service method.</param> <returns>The response from the StartPipelineExecution service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> The specified pipeline was specified in an invalid format or cannot be found. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginStartPipelineExecution(Amazon.CodePipeline.Model.StartPipelineExecutionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="request">Container for the necessary parameters to execute the StartPipelineExecution operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartPipelineExecution operation.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.EndStartPipelineExecution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartPipelineExecution operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartPipelineExecution.</param> <returns>Returns a StartPipelineExecutionResult from CodePipeline.</returns> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.UpdatePipeline(Amazon.CodePipeline.Model.PipelineDeclaration)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="pipeline">The name of the pipeline to be updated.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.UpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest)"> <summary> Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline service method.</param> <returns>The response from the UpdatePipeline service method, as returned by CodePipeline.</returns> <exception cref="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> The specified action declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> The specified gate declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> The specified stage declaration was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.InvalidStructureException"> The specified structure was specified in an invalid format. </exception> <exception cref="T:Amazon.CodePipeline.Model.ValidationException"> The validation was specified in an invalid format. </exception> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineClient.BeginUpdatePipeline(Amazon.CodePipeline.Model.UpdatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdatePipeline operation on AmazonCodePipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CodePipeline.AmazonCodePipelineClient.EndUpdatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdatePipeline.</param> <returns>Returns a UpdatePipelineResult from CodePipeline.</returns> </member> <member name="T:Amazon.CodePipeline.AmazonCodePipelineConfig"> <summary> Configuration for accessing Amazon CodePipeline service </summary> </member> <member name="M:Amazon.CodePipeline.AmazonCodePipelineConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CodePipeline.AmazonCodePipelineConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CodePipeline.AmazonCodePipelineConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CodePipeline.ActionCategory"> <summary> Constants used for properties of type ActionCategory. </summary> </member> <member name="F:Amazon.CodePipeline.ActionCategory.Build"> <summary> Constant Build for ActionCategory </summary> </member> <member name="F:Amazon.CodePipeline.ActionCategory.Deploy"> <summary> Constant Deploy for ActionCategory </summary> </member> <member name="F:Amazon.CodePipeline.ActionCategory.Invoke"> <summary> Constant Invoke for ActionCategory </summary> </member> <member name="F:Amazon.CodePipeline.ActionCategory.Source"> <summary> Constant Source for ActionCategory </summary> </member> <member name="F:Amazon.CodePipeline.ActionCategory.Test"> <summary> Constant Test for ActionCategory </summary> </member> <member name="M:Amazon.CodePipeline.ActionCategory.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ActionCategory.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.ActionConfigurationPropertyType"> <summary> Constants used for properties of type ActionConfigurationPropertyType. </summary> </member> <member name="F:Amazon.CodePipeline.ActionConfigurationPropertyType.Boolean"> <summary> Constant Boolean for ActionConfigurationPropertyType </summary> </member> <member name="F:Amazon.CodePipeline.ActionConfigurationPropertyType.Number"> <summary> Constant Number for ActionConfigurationPropertyType </summary> </member> <member name="F:Amazon.CodePipeline.ActionConfigurationPropertyType.String"> <summary> Constant String for ActionConfigurationPropertyType </summary> </member> <member name="M:Amazon.CodePipeline.ActionConfigurationPropertyType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ActionConfigurationPropertyType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.ActionExecutionStatus"> <summary> Constants used for properties of type ActionExecutionStatus. </summary> </member> <member name="F:Amazon.CodePipeline.ActionExecutionStatus.Failed"> <summary> Constant Failed for ActionExecutionStatus </summary> </member> <member name="F:Amazon.CodePipeline.ActionExecutionStatus.InProgress"> <summary> Constant InProgress for ActionExecutionStatus </summary> </member> <member name="F:Amazon.CodePipeline.ActionExecutionStatus.Succeeded"> <summary> Constant Succeeded for ActionExecutionStatus </summary> </member> <member name="M:Amazon.CodePipeline.ActionExecutionStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ActionExecutionStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.ActionOwner"> <summary> Constants used for properties of type ActionOwner. </summary> </member> <member name="F:Amazon.CodePipeline.ActionOwner.AWS"> <summary> Constant AWS for ActionOwner </summary> </member> <member name="F:Amazon.CodePipeline.ActionOwner.Custom"> <summary> Constant Custom for ActionOwner </summary> </member> <member name="F:Amazon.CodePipeline.ActionOwner.ThirdParty"> <summary> Constant ThirdParty for ActionOwner </summary> </member> <member name="M:Amazon.CodePipeline.ActionOwner.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ActionOwner.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.ArtifactLocationType"> <summary> Constants used for properties of type ArtifactLocationType. </summary> </member> <member name="F:Amazon.CodePipeline.ArtifactLocationType.S3"> <summary> Constant S3 for ArtifactLocationType </summary> </member> <member name="M:Amazon.CodePipeline.ArtifactLocationType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ArtifactLocationType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.ArtifactStoreType"> <summary> Constants used for properties of type ArtifactStoreType. </summary> </member> <member name="F:Amazon.CodePipeline.ArtifactStoreType.S3"> <summary> Constant S3 for ArtifactStoreType </summary> </member> <member name="M:Amazon.CodePipeline.ArtifactStoreType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.ArtifactStoreType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.BlockerType"> <summary> Constants used for properties of type BlockerType. </summary> </member> <member name="F:Amazon.CodePipeline.BlockerType.Schedule"> <summary> Constant Schedule for BlockerType </summary> </member> <member name="M:Amazon.CodePipeline.BlockerType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.BlockerType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.EncryptionKeyType"> <summary> Constants used for properties of type EncryptionKeyType. </summary> </member> <member name="F:Amazon.CodePipeline.EncryptionKeyType.KMS"> <summary> Constant KMS for EncryptionKeyType </summary> </member> <member name="M:Amazon.CodePipeline.EncryptionKeyType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.EncryptionKeyType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.FailureType"> <summary> Constants used for properties of type FailureType. </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.ConfigurationError"> <summary> Constant ConfigurationError for FailureType </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.JobFailed"> <summary> Constant JobFailed for FailureType </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.PermissionError"> <summary> Constant PermissionError for FailureType </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.RevisionOutOfSync"> <summary> Constant RevisionOutOfSync for FailureType </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.RevisionUnavailable"> <summary> Constant RevisionUnavailable for FailureType </summary> </member> <member name="F:Amazon.CodePipeline.FailureType.SystemUnavailable"> <summary> Constant SystemUnavailable for FailureType </summary> </member> <member name="M:Amazon.CodePipeline.FailureType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.FailureType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.JobStatus"> <summary> Constants used for properties of type JobStatus. </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.Created"> <summary> Constant Created for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.Dispatched"> <summary> Constant Dispatched for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.Failed"> <summary> Constant Failed for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.InProgress"> <summary> Constant InProgress for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.Queued"> <summary> Constant Queued for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.Succeeded"> <summary> Constant Succeeded for JobStatus </summary> </member> <member name="F:Amazon.CodePipeline.JobStatus.TimedOut"> <summary> Constant TimedOut for JobStatus </summary> </member> <member name="M:Amazon.CodePipeline.JobStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.JobStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.StageTransitionType"> <summary> Constants used for properties of type StageTransitionType. </summary> </member> <member name="F:Amazon.CodePipeline.StageTransitionType.Inbound"> <summary> Constant Inbound for StageTransitionType </summary> </member> <member name="F:Amazon.CodePipeline.StageTransitionType.Outbound"> <summary> Constant Outbound for StageTransitionType </summary> </member> <member name="M:Amazon.CodePipeline.StageTransitionType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CodePipeline.StageTransitionType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeJobRequest"> <summary> Container for the parameters to the AcknowledgeJob operation. Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions. </summary> </member> <member name="T:Amazon.CodePipeline.AmazonCodePipelineRequest"> <summary> Base class for CodePipeline operation requests. </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeJobRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID of the job for which you want to confirm receipt. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeJobRequest.Nonce"> <summary> Gets and sets the property Nonce. <para> A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeJobResponse"> <summary> Configuration for accessing Amazon AcknowledgeJob service </summary> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeJobResult"> <summary> Represents the output of an acknowledge job action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeJobResult.Status"> <summary> Gets and sets the property Status. <para> Whether the job worker has received the specified job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeJobResponse.AcknowledgeJobResult"> <summary> Gets and sets the AcknowledgeJobResult property. Represents the output of a AcknowledgeJob operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest"> <summary> Container for the parameters to the AcknowledgeThirdPartyJob operation. Confirms a job worker has received the specified job. Only used for partner actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID of the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobRequest.Nonce"> <summary> Gets and sets the property Nonce. <para> A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobResponse"> <summary> Configuration for accessing Amazon AcknowledgeThirdPartyJob service </summary> </member> <member name="T:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobResult"> <summary> Represents the output of an acknowledge third party job action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobResult.Status"> <summary> Gets and sets the property Status. <para> The status information for the third party job, if any. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AcknowledgeThirdPartyJobResponse.AcknowledgeThirdPartyJobResult"> <summary> Gets and sets the AcknowledgeThirdPartyJobResult property. Represents the output of a AcknowledgeThirdPartyJob operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionConfiguration"> <summary> Represents information about an action configuration. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfiguration.Configuration"> <summary> Gets and sets the property Configuration. <para> The configuration data for the action. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionConfigurationProperty"> <summary> Represents information about an action configuration property. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Description"> <summary> Gets and sets the property Description. <para> The description of the action configuration property that will be displayed to users. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Key"> <summary> Gets and sets the property Key. <para> Whether the configuration property is a key. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Name"> <summary> Gets and sets the property Name. <para> The name of the action configuration property. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Queryable"> <summary> Gets and sets the property Queryable. <para> Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. </para> <para> If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Required"> <summary> Gets and sets the property Required. <para> Whether the configuration property is a required value. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Secret"> <summary> Gets and sets the property Secret. <para> Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. </para> <para> When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionConfigurationProperty.Type"> <summary> Gets and sets the property Type. <para> The type of the configuration property. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionContext"> <summary> Represents the context of an action within the stage of a pipeline to a job worker. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionContext.Name"> <summary> Gets and sets the property Name. <para> The name of the action within the context of a job. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionDeclaration"> <summary> Represents information about an action declaration. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.ActionTypeId"> <summary> Gets and sets the property ActionTypeId. <para> The configuration information for the action type. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.Configuration"> <summary> Gets and sets the property Configuration. <para> The action declaration's configuration. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.InputArtifacts"> <summary> Gets and sets the property InputArtifacts. <para> The name or ID of the artifact consumed by the action, such as a test or build artifact. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.Name"> <summary> Gets and sets the property Name. <para> The action declaration's name. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.OutputArtifacts"> <summary> Gets and sets the property OutputArtifacts. <para> The name or ID of the result of the action declaration, such as a test or build artifact. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionDeclaration.RunOrder"> <summary> Gets and sets the property RunOrder. <para> The order in which actions are run. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionExecution"> <summary> Represents information about how an action runs. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.ErrorDetails"> <summary> Gets and sets the property ErrorDetails. <para> The details of an error returned by a URL external to AWS. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.ExternalExecutionId"> <summary> Gets and sets the property ExternalExecutionId. <para> The external ID of the run of the action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.ExternalExecutionUrl"> <summary> Gets and sets the property ExternalExecutionUrl. <para> The URL of a resource external to AWS that will be used when running the action, for example an external repository URL. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.LastStatusChange"> <summary> Gets and sets the property LastStatusChange. <para> The last status change of the action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.PercentComplete"> <summary> Gets and sets the property PercentComplete. <para> A percentage of completeness of the action as it runs. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.Status"> <summary> Gets and sets the property Status. <para> The status of the action, or for a completed action, the last status of the action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionExecution.Summary"> <summary> Gets and sets the property Summary. <para> A summary of the run of the action. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.ActionNotFoundException.#ctor(System.String)"> <summary> Constructs a new ActionNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.ActionRevision"> <summary> Represents information about the version (or revision) of an action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionRevision.Created"> <summary> Gets and sets the property Created. <para> The date and time when the most recent version of the action was created, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionRevision.RevisionChangeId"> <summary> Gets and sets the property RevisionChangeId. <para> The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionRevision.RevisionId"> <summary> Gets and sets the property RevisionId. <para> The system-generated unique ID that identifies the revision number of the action. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionState"> <summary> Represents information about the state of an action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionState.ActionName"> <summary> Gets and sets the property ActionName. <para> The name of the action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionState.CurrentRevision"> <summary> Gets and sets the property CurrentRevision. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionState.EntityUrl"> <summary> Gets and sets the property EntityUrl. <para> A URL link for more information about the state of the action, such as a deployment group details page. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionState.LatestExecution"> <summary> Gets and sets the property LatestExecution. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionState.RevisionUrl"> <summary> Gets and sets the property RevisionUrl. <para> A URL link for more information about the revision, such as a commit details page. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionType"> <summary> Returns information about the details of an action type. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionType.ActionConfigurationProperties"> <summary> Gets and sets the property ActionConfigurationProperties. <para> The configuration properties for the action type. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionType.Id"> <summary> Gets and sets the property Id. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionType.InputArtifactDetails"> <summary> Gets and sets the property InputArtifactDetails. <para> The details of the input artifact for the action, such as its commit ID. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionType.OutputArtifactDetails"> <summary> Gets and sets the property OutputArtifactDetails. <para> The details of the output artifact of the action, such as its commit ID. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionType.Settings"> <summary> Gets and sets the property Settings. <para> The settings for the action type. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionTypeId"> <summary> Represents information about an action type. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeId.Category"> <summary> Gets and sets the property Category. <para> A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeId.Owner"> <summary> Gets and sets the property Owner. <para> The creator of the action being called. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeId.Provider"> <summary> Gets and sets the property Provider. <para> The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeId.Version"> <summary> Gets and sets the property Version. <para> A string that identifies the action type. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ActionTypeNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.ActionTypeNotFoundException.#ctor(System.String)"> <summary> Constructs a new ActionTypeNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.ActionTypeSettings"> <summary> Returns information about the settings for an action type. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeSettings.EntityUrlTemplate"> <summary> Gets and sets the property EntityUrlTemplate. <para> The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeSettings.ExecutionUrlTemplate"> <summary> Gets and sets the property ExecutionUrlTemplate. <para> The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeSettings.RevisionUrlTemplate"> <summary> Gets and sets the property RevisionUrlTemplate. <para> The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ActionTypeSettings.ThirdPartyConfigurationUrl"> <summary> Gets and sets the property ThirdPartyConfigurationUrl. <para> The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.Artifact"> <summary> Represents information about an artifact that will be worked upon by actions in the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.Artifact.Location"> <summary> Gets and sets the property Location. <para> The location of an artifact. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.Artifact.Name"> <summary> Gets and sets the property Name. <para> The artifact's name. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.Artifact.Revision"> <summary> Gets and sets the property Revision. <para> The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3). </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ArtifactDetails"> <summary> Returns information about the details of an artifact. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactDetails.MaximumCount"> <summary> Gets and sets the property MaximumCount. <para> The maximum number of artifacts allowed for the action type. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactDetails.MinimumCount"> <summary> Gets and sets the property MinimumCount. <para> The minimum number of artifacts allowed for the action type. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ArtifactLocation"> <summary> Represents information about the location of an artifact. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactLocation.S3Location"> <summary> Gets and sets the property S3Location. <para> The Amazon S3 bucket that contains the artifact. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactLocation.Type"> <summary> Gets and sets the property Type. <para> The type of artifact in the location. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ArtifactStore"> <summary> The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the <ulink url="http://docs.aws.amazon.com/codepipeline/latest/UserGuide/concepts.html">Concepts</ulink>. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactStore.EncryptionKey"> <summary> Gets and sets the property EncryptionKey. <para> The AWS Key Management Service (AWS KMS) key used to encrypt the data in the artifact store. If this is undefined, the default key for Amazon S3 is used. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactStore.Location"> <summary> Gets and sets the property Location. <para> The location for storing the artifacts for a pipeline, such as an S3 bucket or folder. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ArtifactStore.Type"> <summary> Gets and sets the property Type. <para> The type of the artifact store, such as S3. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.AWSSessionCredentials"> <summary> Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.AWSSessionCredentials.AccessKeyId"> <summary> Gets and sets the property AccessKeyId. <para> The access key for the session. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AWSSessionCredentials.SecretAccessKey"> <summary> Gets and sets the property SecretAccessKey. <para> The secret access key for the session. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.AWSSessionCredentials.SessionToken"> <summary> Gets and sets the property SessionToken. <para> The token for the session. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.BlockerDeclaration"> <summary> Represents information about a gate declaration. </summary> </member> <member name="P:Amazon.CodePipeline.Model.BlockerDeclaration.Name"> <summary> Gets and sets the property Name. <para> The name of the gate declaration. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.BlockerDeclaration.Type"> <summary> Gets and sets the property Type. <para> The type of the gate declaration. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest"> <summary> Container for the parameters to the CreateCustomActionType operation. Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.Category"> <summary> Gets and sets the property Category. <para> The category of the custom action, such as a source action or a build action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.ConfigurationProperties"> <summary> Gets and sets the property ConfigurationProperties. <para> The configuration properties for the custom action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.InputArtifactDetails"> <summary> Gets and sets the property InputArtifactDetails. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.OutputArtifactDetails"> <summary> Gets and sets the property OutputArtifactDetails. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.Provider"> <summary> Gets and sets the property Provider. <para> The provider of the service used in the custom action, such as AWS CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.Settings"> <summary> Gets and sets the property Settings. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeRequest.Version"> <summary> Gets and sets the property Version. <para> The version number of the custom action. </para> <note>A newly-created custom action is always assigned a version number of <code>1</code>. This is required.</note> </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreateCustomActionTypeResponse"> <summary> Configuration for accessing Amazon CreateCustomActionType service </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreateCustomActionTypeResult"> <summary> Represents the output of a create custom action operation. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeResult.ActionType"> <summary> Gets and sets the property ActionType. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreateCustomActionTypeResponse.CreateCustomActionTypeResult"> <summary> Gets and sets the CreateCustomActionTypeResult property. Represents the output of a CreateCustomActionType operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreatePipelineRequest"> <summary> Container for the parameters to the CreatePipeline operation. Creates a pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreatePipelineRequest.Pipeline"> <summary> Gets and sets the property Pipeline. </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreatePipelineResponse"> <summary> Configuration for accessing Amazon CreatePipeline service </summary> </member> <member name="T:Amazon.CodePipeline.Model.CreatePipelineResult"> <summary> Represents the output of a create pipeline action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreatePipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CreatePipelineResponse.CreatePipelineResult"> <summary> Gets and sets the CreatePipelineResult property. Represents the output of a CreatePipeline operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.CurrentRevision"> <summary> Represents information about a current revision. </summary> </member> <member name="P:Amazon.CodePipeline.Model.CurrentRevision.ChangeIdentifier"> <summary> Gets and sets the property ChangeIdentifier. <para> The change identifier for the current revision. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.CurrentRevision.Revision"> <summary> Gets and sets the property Revision. <para> The revision ID of the current version of an artifact. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest"> <summary> Container for the parameters to the DeleteCustomActionType operation. Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions. <important> <para> You cannot recreate a custom action after it has been deleted unless you increase the version number of the action. </para> </important> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest.Category"> <summary> Gets and sets the property Category. <para> The category of the custom action that you want to delete, such as source or deploy. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest.Provider"> <summary> Gets and sets the property Provider. <para> The provider of the service used in the custom action, such as AWS CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DeleteCustomActionTypeRequest.Version"> <summary> Gets and sets the property Version. <para> The version of the custom action to delete. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.DeletePipelineRequest"> <summary> Container for the parameters to the DeletePipeline operation. Deletes the specified pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.DeletePipelineRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline to be deleted. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.DisableStageTransitionRequest"> <summary> Container for the parameters to the DisableStageTransition operation. Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.DisableStageTransitionRequest.PipelineName"> <summary> Gets and sets the property PipelineName. <para> The name of the pipeline in which you want to disable the flow of artifacts from one stage to another. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DisableStageTransitionRequest.Reason"> <summary> Gets and sets the property Reason. <para> The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DisableStageTransitionRequest.StageName"> <summary> Gets and sets the property StageName. <para> The name of the stage where you want to disable the inbound or outbound transition of artifacts. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.DisableStageTransitionRequest.TransitionType"> <summary> Gets and sets the property TransitionType. <para> Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound). </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.EnableStageTransitionRequest"> <summary> Container for the parameters to the EnableStageTransition operation. Enables artifacts in a pipeline to transition to a stage in a pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.EnableStageTransitionRequest.PipelineName"> <summary> Gets and sets the property PipelineName. <para> The name of the pipeline in which you want to enable the flow of artifacts from one stage to another. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.EnableStageTransitionRequest.StageName"> <summary> Gets and sets the property StageName. <para> The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound). </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.EnableStageTransitionRequest.TransitionType"> <summary> Gets and sets the property TransitionType. <para> Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound). </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.EncryptionKey"> <summary> Represents information about the AWS Key Management Service (AWS KMS) key used to encrypt data in the artifact store. </summary> </member> <member name="P:Amazon.CodePipeline.Model.EncryptionKey.Id"> <summary> Gets and sets the property Id. <para> The ID of the AWS KMS key. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.EncryptionKey.Type"> <summary> Gets and sets the property Type. <para> The type of AWS KMS key, such as a customer master key. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ErrorDetails"> <summary> Represents information about an error in AWS CodePipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ErrorDetails.Code"> <summary> Gets and sets the property Code. <para> The system ID or error number code of the error. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ErrorDetails.Message"> <summary> Gets and sets the property Message. <para> The text of the error message. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ExecutionDetails"> <summary> The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ExecutionDetails.ExternalExecutionId"> <summary> Gets and sets the property ExternalExecutionId. <para> The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ExecutionDetails.PercentComplete"> <summary> Gets and sets the property PercentComplete. <para> The percentage of work completed on the action, represented on a scale of zero to one hundred percent. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ExecutionDetails.Summary"> <summary> Gets and sets the property Summary. <para> The summary of the current status of the actions. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.FailureDetails"> <summary> Represents information about failure details. </summary> </member> <member name="P:Amazon.CodePipeline.Model.FailureDetails.ExternalExecutionId"> <summary> Gets and sets the property ExternalExecutionId. <para> The external ID of the run of the action that failed. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.FailureDetails.Message"> <summary> Gets and sets the property Message. <para> The message about the failure. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.FailureDetails.Type"> <summary> Gets and sets the property Type. <para> The type of the failure. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetJobDetailsRequest"> <summary> Container for the parameters to the GetJobDetails operation. Returns information about a job. Only used for custom actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetJobDetailsRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID for the job. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetJobDetailsResponse"> <summary> Configuration for accessing Amazon GetJobDetails service </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetJobDetailsResult"> <summary> Represents the output of a get job details action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetJobDetailsResult.JobDetails"> <summary> Gets and sets the property JobDetails. <para> The details of the job. </para> <note> <para> If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials. </para> </note> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetJobDetailsResponse.GetJobDetailsResult"> <summary> Gets and sets the GetJobDetailsResult property. Represents the output of a GetJobDetails operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineRequest"> <summary> Container for the parameters to the GetPipeline operation. Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineRequest.Version"> <summary> Gets and sets the property Version. <para> The version number of the pipeline. If you do not specify a version, defaults to the most current version. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineResponse"> <summary> Configuration for accessing Amazon GetPipeline service </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineResult"> <summary> Represents the output of a get pipeline action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineResponse.GetPipelineResult"> <summary> Gets and sets the GetPipelineResult property. Represents the output of a GetPipeline operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineStateRequest"> <summary> Container for the parameters to the GetPipelineState operation. Returns information about the state of a pipeline, including the stages, actions, and details about the last run of the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline about which you want to get information. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineStateResponse"> <summary> Configuration for accessing Amazon GetPipelineState service </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetPipelineStateResult"> <summary> Represents the output of a get pipeline state action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResult.Created"> <summary> Gets and sets the property Created. <para> The date and time the pipeline was created, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResult.PipelineName"> <summary> Gets and sets the property PipelineName. <para> The name of the pipeline for which you want to get the state. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResult.PipelineVersion"> <summary> Gets and sets the property PipelineVersion. <para> The version number of the pipeline. </para> <note>A newly-created pipeline is always assigned a version number of <code>1</code>.</note> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResult.StageStates"> <summary> Gets and sets the property StageStates. <para> A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResult.Updated"> <summary> Gets and sets the property Updated. <para> The date and time the pipeline was last updated, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetPipelineStateResponse.GetPipelineStateResult"> <summary> Gets and sets the GetPipelineStateResult property. Represents the output of a GetPipelineState operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest"> <summary> Container for the parameters to the GetThirdPartyJobDetails operation. Requests the details of a job for a third party action. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID used for identifying the job. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsResponse"> <summary> Configuration for accessing Amazon GetThirdPartyJobDetails service </summary> </member> <member name="T:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsResult"> <summary> Represents the output of a get third party job details action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsResult.JobDetails"> <summary> Gets and sets the property JobDetails. <para> The details of the job, including any protected values defined for the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.GetThirdPartyJobDetailsResponse.GetThirdPartyJobDetailsResult"> <summary> Gets and sets the GetThirdPartyJobDetailsResult property. Represents the output of a GetThirdPartyJobDetails operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.InputArtifact"> <summary> Represents information about an artifact to be worked on, such as a test or build artifact. </summary> </member> <member name="P:Amazon.CodePipeline.Model.InputArtifact.Name"> <summary> Gets and sets the property Name. <para> The name of the artifact to be worked on, for example, "My App". </para> <para> The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.InvalidActionDeclarationException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidActionDeclarationException.#ctor(System.String)"> <summary> Constructs a new InvalidActionDeclarationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidBlockerDeclarationException.#ctor(System.String)"> <summary> Constructs a new InvalidBlockerDeclarationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidClientTokenException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidClientTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidClientTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidJobException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidJobException.#ctor(System.String)"> <summary> Constructs a new InvalidJobException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidJobStateException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidJobStateException.#ctor(System.String)"> <summary> Constructs a new InvalidJobStateException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidNextTokenException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.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.CodePipeline.Model.InvalidNonceException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidNonceException.#ctor(System.String)"> <summary> Constructs a new InvalidNonceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidStageDeclarationException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidStageDeclarationException.#ctor(System.String)"> <summary> Constructs a new InvalidStageDeclarationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.InvalidStructureException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.InvalidStructureException.#ctor(System.String)"> <summary> Constructs a new InvalidStructureException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.Job"> <summary> Represents information about a job. </summary> </member> <member name="P:Amazon.CodePipeline.Model.Job.AccountId"> <summary> Gets and sets the property AccountId. <para> The ID of the AWS account to use when performing the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.Job.Data"> <summary> Gets and sets the property Data. <para> Additional data about a job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.Job.Id"> <summary> Gets and sets the property Id. <para> The unique system-generated ID of the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.Job.Nonce"> <summary> Gets and sets the property Nonce. <para> A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.JobData"> <summary> Represents additional information about a job required for a job worker to complete the job. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.ActionConfiguration"> <summary> Gets and sets the property ActionConfiguration. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.ActionTypeId"> <summary> Gets and sets the property ActionTypeId. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.ArtifactCredentials"> <summary> Gets and sets the property ArtifactCredentials. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.ContinuationToken"> <summary> Gets and sets the property ContinuationToken. <para> A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.EncryptionKey"> <summary> Gets and sets the property EncryptionKey. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.InputArtifacts"> <summary> Gets and sets the property InputArtifacts. <para> The artifact supplied to the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.OutputArtifacts"> <summary> Gets and sets the property OutputArtifacts. <para> The output of the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobData.PipelineContext"> <summary> Gets and sets the property PipelineContext. </summary> </member> <member name="T:Amazon.CodePipeline.Model.JobDetails"> <summary> Represents information about the details of a job. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobDetails.AccountId"> <summary> Gets and sets the property AccountId. <para> The AWS account ID associated with the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobDetails.Data"> <summary> Gets and sets the property Data. </summary> </member> <member name="P:Amazon.CodePipeline.Model.JobDetails.Id"> <summary> Gets and sets the property Id. <para> The unique system-generated ID of the job. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.JobNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.JobNotFoundException.#ctor(System.String)"> <summary> Constructs a new JobNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.LimitExceededException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.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.CodePipeline.Model.ListActionTypesRequest"> <summary> Container for the parameters to the ListActionTypes operation. Gets a summary of all AWS CodePipeline action types associated with your account. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListActionTypesRequest.ActionOwnerFilter"> <summary> Gets and sets the property ActionOwnerFilter. <para> Filters the list of action types to those created by a specified entity. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListActionTypesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ListActionTypesResponse"> <summary> Configuration for accessing Amazon ListActionTypes service </summary> </member> <member name="T:Amazon.CodePipeline.Model.ListActionTypesResult"> <summary> Represents the output of a list action types action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListActionTypesResult.ActionTypes"> <summary> Gets and sets the property ActionTypes. <para> Provides details of the action types. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListActionTypesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListActionTypesResponse.ListActionTypesResult"> <summary> Gets and sets the ListActionTypesResult property. Represents the output of a ListActionTypes operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.ListPipelinesRequest"> <summary> Container for the parameters to the ListPipelines operation. Gets a summary of all of the pipelines associated with your account. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListPipelinesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ListPipelinesResponse"> <summary> Configuration for accessing Amazon ListPipelines service </summary> </member> <member name="T:Amazon.CodePipeline.Model.ListPipelinesResult"> <summary> Represents the output of a list pipelines action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListPipelinesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListPipelinesResult.Pipelines"> <summary> Gets and sets the property Pipelines. <para> The list of pipelines. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ListPipelinesResponse.ListPipelinesResult"> <summary> Gets and sets the ListPipelinesResult property. Represents the output of a ListPipelines operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.OutputArtifact"> <summary> Represents information about the output of an action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.OutputArtifact.Name"> <summary> Gets and sets the property Name. <para> The name of the output of an artifact, such as "My App". </para> <para> The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. </para> <para> Output artifact names must be unique within a pipeline. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PipelineContext"> <summary> Represents information about a pipeline to a job worker. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineContext.Action"> <summary> Gets and sets the property Action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineContext.PipelineName"> <summary> Gets and sets the property PipelineName. <para> The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineContext.Stage"> <summary> Gets and sets the property Stage. <para> The stage of the pipeline. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PipelineDeclaration"> <summary> Represents the structure of actions and stages to be performed in the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineDeclaration.ArtifactStore"> <summary> Gets and sets the property ArtifactStore. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineDeclaration.Name"> <summary> Gets and sets the property Name. <para> The name of the action to be performed. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineDeclaration.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineDeclaration.Stages"> <summary> Gets and sets the property Stages. <para> The stage in which to perform the action. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineDeclaration.Version"> <summary> Gets and sets the property Version. <para> The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PipelineNameInUseException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.PipelineNameInUseException.#ctor(System.String)"> <summary> Constructs a new PipelineNameInUseException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.PipelineNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.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.CodePipeline.Model.PipelineSummary"> <summary> Returns a summary of a pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineSummary.Created"> <summary> Gets and sets the property Created. <para> The date and time the pipeline was created, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineSummary.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineSummary.Updated"> <summary> Gets and sets the property Updated. <para> The date and time of the last update to the pipeline, in timestamp format. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PipelineSummary.Version"> <summary> Gets and sets the property Version. <para> The version number of the pipeline. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PipelineVersionNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.PipelineVersionNotFoundException.#ctor(System.String)"> <summary> Constructs a new PipelineVersionNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.PollForJobsRequest"> <summary> Container for the parameters to the PollForJobs operation. Returns information about any jobs for AWS CodePipeline to act upon. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action. </para> </important> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForJobsRequest.ActionTypeId"> <summary> Gets and sets the property ActionTypeId. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForJobsRequest.MaxBatchSize"> <summary> Gets and sets the property MaxBatchSize. <para> The maximum number of jobs to return in a poll for jobs call. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForJobsRequest.QueryParam"> <summary> Gets and sets the property QueryParam. <para> A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PollForJobsResponse"> <summary> Configuration for accessing Amazon PollForJobs service </summary> </member> <member name="T:Amazon.CodePipeline.Model.PollForJobsResult"> <summary> Represents the output of a poll for jobs action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForJobsResult.Jobs"> <summary> Gets and sets the property Jobs. <para> Information about the jobs to take action on. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForJobsResponse.PollForJobsResult"> <summary> Gets and sets the PollForJobsResult property. Represents the output of a PollForJobs operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest"> <summary> Container for the parameters to the PollForThirdPartyJobs operation. Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions. <important> <para> When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. </para> </important> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest.ActionTypeId"> <summary> Gets and sets the property ActionTypeId. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForThirdPartyJobsRequest.MaxBatchSize"> <summary> Gets and sets the property MaxBatchSize. <para> The maximum number of jobs to return in a poll for jobs call. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PollForThirdPartyJobsResponse"> <summary> Configuration for accessing Amazon PollForThirdPartyJobs service </summary> </member> <member name="T:Amazon.CodePipeline.Model.PollForThirdPartyJobsResult"> <summary> Represents the output of a poll for third party jobs action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForThirdPartyJobsResult.Jobs"> <summary> Gets and sets the property Jobs. <para> Information about the jobs to take action on. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PollForThirdPartyJobsResponse.PollForThirdPartyJobsResult"> <summary> Gets and sets the PollForThirdPartyJobsResult property. Represents the output of a PollForThirdPartyJobs operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutActionRevisionRequest"> <summary> Container for the parameters to the PutActionRevision operation. Provides information to AWS CodePipeline about new revisions to a source. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionRequest.ActionName"> <summary> Gets and sets the property ActionName. <para> The name of the action that will process the revision. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionRequest.ActionRevision"> <summary> Gets and sets the property ActionRevision. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionRequest.PipelineName"> <summary> Gets and sets the property PipelineName. <para> The name of the pipeline that will start processing the revision to the source. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionRequest.StageName"> <summary> Gets and sets the property StageName. <para> The name of the stage that contains the action that will act upon the revision. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutActionRevisionResponse"> <summary> Configuration for accessing Amazon PutActionRevision service </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutActionRevisionResult"> <summary> Represents the output of a put action revision action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionResult.NewRevision"> <summary> Gets and sets the property NewRevision. <para> The new revision number or ID for the revision after the action completes. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionResult.PipelineExecutionId"> <summary> Gets and sets the property PipelineExecutionId. <para> The ID of the current workflow state of the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutActionRevisionResponse.PutActionRevisionResult"> <summary> Gets and sets the PutActionRevisionResult property. Represents the output of a PutActionRevision operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutJobFailureResultRequest"> <summary> Container for the parameters to the PutJobFailureResult operation. Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobFailureResultRequest.FailureDetails"> <summary> Gets and sets the property FailureDetails. <para> The details about the failure of a job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobFailureResultRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutJobSuccessResultRequest"> <summary> Container for the parameters to the PutJobSuccessResult operation. Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobSuccessResultRequest.ContinuationToken"> <summary> Gets and sets the property ContinuationToken. <para> A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobSuccessResultRequest.CurrentRevision"> <summary> Gets and sets the property CurrentRevision. <para> The ID of the current revision of the artifact successfully worked upon by the job. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobSuccessResultRequest.ExecutionDetails"> <summary> Gets and sets the property ExecutionDetails. <para> The execution details of the successful job, such as the actions taken by the job worker. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutJobSuccessResultRequest.JobId"> <summary> Gets and sets the property JobId. <para> The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest"> <summary> Container for the parameters to the PutThirdPartyJobFailureResult operation. Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest.FailureDetails"> <summary> Gets and sets the property FailureDetails. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobFailureResultRequest.JobId"> <summary> Gets and sets the property JobId. <para> The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest"> <summary> Container for the parameters to the PutThirdPartyJobSuccessResult operation. Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest.ContinuationToken"> <summary> Gets and sets the property ContinuationToken. <para> A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest.CurrentRevision"> <summary> Gets and sets the property CurrentRevision. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest.ExecutionDetails"> <summary> Gets and sets the property ExecutionDetails. </summary> </member> <member name="P:Amazon.CodePipeline.Model.PutThirdPartyJobSuccessResultRequest.JobId"> <summary> Gets and sets the property JobId. <para> The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.S3ArtifactLocation"> <summary> The location of the Amazon S3 bucket that contains a revision. </summary> </member> <member name="P:Amazon.CodePipeline.Model.S3ArtifactLocation.BucketName"> <summary> Gets and sets the property BucketName. <para> The name of the Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.S3ArtifactLocation.ObjectKey"> <summary> Gets and sets the property ObjectKey. <para> The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.StageContext"> <summary> Represents information about a stage to a job worker. </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageContext.Name"> <summary> Gets and sets the property Name. <para> The name of the stage. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.StageDeclaration"> <summary> Represents information about a stage and its definition. </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageDeclaration.Actions"> <summary> Gets and sets the property Actions. <para> The actions included in a stage. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageDeclaration.Blockers"> <summary> Gets and sets the property Blockers. <para> The gates included in a stage. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageDeclaration.Name"> <summary> Gets and sets the property Name. <para> The name of the stage. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.StageNotFoundException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.Model.StageNotFoundException.#ctor(System.String)"> <summary> Constructs a new StageNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CodePipeline.Model.StageState"> <summary> Represents information about the state of the stage. </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageState.ActionStates"> <summary> Gets and sets the property ActionStates. <para> The state of the stage. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageState.InboundTransitionState"> <summary> Gets and sets the property InboundTransitionState. <para> The state of the inbound transition, which is either enabled or disabled. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.StageState.StageName"> <summary> Gets and sets the property StageName. <para> The name of the stage. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.StartPipelineExecutionRequest"> <summary> Container for the parameters to the StartPipelineExecution operation. Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline. </summary> </member> <member name="P:Amazon.CodePipeline.Model.StartPipelineExecutionRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline to start. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.StartPipelineExecutionResponse"> <summary> Configuration for accessing Amazon StartPipelineExecution service </summary> </member> <member name="T:Amazon.CodePipeline.Model.StartPipelineExecutionResult"> <summary> Represents the output of a start pipeline execution action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.StartPipelineExecutionResult.PipelineExecutionId"> <summary> Gets and sets the property PipelineExecutionId. <para> The unique system-generated ID of the pipeline that was started. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.StartPipelineExecutionResponse.StartPipelineExecutionResult"> <summary> Gets and sets the StartPipelineExecutionResult property. Represents the output of a StartPipelineExecution operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.ThirdPartyJob"> <summary> A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJob.ClientId"> <summary> Gets and sets the property ClientId. <para> The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJob.JobId"> <summary> Gets and sets the property JobId. <para> The identifier used to identify the job in AWS CodePipeline. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.ThirdPartyJobData"> <summary> Represents information about the job data for a partner action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.ActionConfiguration"> <summary> Gets and sets the property ActionConfiguration. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.ActionTypeId"> <summary> Gets and sets the property ActionTypeId. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.ArtifactCredentials"> <summary> Gets and sets the property ArtifactCredentials. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.ContinuationToken"> <summary> Gets and sets the property ContinuationToken. <para> A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.EncryptionKey"> <summary> Gets and sets the property EncryptionKey. <para> The AWS Key Management Service (AWS KMS) key used to encrypt and decrypt data in the artifact store for the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.InputArtifacts"> <summary> Gets and sets the property InputArtifacts. <para> The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.OutputArtifacts"> <summary> Gets and sets the property OutputArtifacts. <para> The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobData.PipelineContext"> <summary> Gets and sets the property PipelineContext. </summary> </member> <member name="T:Amazon.CodePipeline.Model.ThirdPartyJobDetails"> <summary> The details of a job sent in response to a GetThirdPartyJobDetails request. </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobDetails.Data"> <summary> Gets and sets the property Data. <para> The data to be returned by the third party job worker. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobDetails.Id"> <summary> Gets and sets the property Id. <para> The identifier used to identify the job details in AWS CodePipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.ThirdPartyJobDetails.Nonce"> <summary> Gets and sets the property Nonce. <para> A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.TransitionState"> <summary> Represents information about the state of transitions between one stage and another stage. </summary> </member> <member name="P:Amazon.CodePipeline.Model.TransitionState.DisabledReason"> <summary> Gets and sets the property DisabledReason. <para> The user-specified reason why the transition between two stages of a pipeline was disabled. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.TransitionState.Enabled"> <summary> Gets and sets the property Enabled. <para> Whether the transition between stages is enabled (true) or disabled (false). </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.TransitionState.LastChangedAt"> <summary> Gets and sets the property LastChangedAt. <para> The timestamp when the transition state was last changed. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.TransitionState.LastChangedBy"> <summary> Gets and sets the property LastChangedBy. <para> The ID of the user who last changed the transition state. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.UpdatePipelineRequest"> <summary> Container for the parameters to the UpdatePipeline operation. Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1. </summary> </member> <member name="P:Amazon.CodePipeline.Model.UpdatePipelineRequest.Pipeline"> <summary> Gets and sets the property Pipeline. <para> The name of the pipeline to be updated. </para> </summary> </member> <member name="T:Amazon.CodePipeline.Model.UpdatePipelineResponse"> <summary> Configuration for accessing Amazon UpdatePipeline service </summary> </member> <member name="T:Amazon.CodePipeline.Model.UpdatePipelineResult"> <summary> Represents the output of an update pipeline action. </summary> </member> <member name="P:Amazon.CodePipeline.Model.UpdatePipelineResult.Pipeline"> <summary> Gets and sets the property Pipeline. <para> The structure of the updated pipeline. </para> </summary> </member> <member name="P:Amazon.CodePipeline.Model.UpdatePipelineResponse.UpdatePipelineResult"> <summary> Gets and sets the UpdatePipelineResult property. Represents the output of a UpdatePipeline operation. </summary> </member> <member name="T:Amazon.CodePipeline.Model.ValidationException"> <summary> CodePipeline exception </summary> </member> <member name="M:Amazon.CodePipeline.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.CodePipeline.Model.Internal.MarshallTransformations.AcknowledgeJobRequestMarshaller"> <summary> AcknowledgeJob Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.AcknowledgeJobResponseUnmarshaller"> <summary> Response Unmarshaller for AcknowledgeJob operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.AcknowledgeThirdPartyJobRequestMarshaller"> <summary> AcknowledgeThirdPartyJob Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.AcknowledgeThirdPartyJobResponseUnmarshaller"> <summary> Response Unmarshaller for AcknowledgeThirdPartyJob operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionConfigurationPropertyMarshaller"> <summary> ActionConfigurationProperty Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionConfigurationPropertyUnmarshaller"> <summary> Response Unmarshaller for ActionConfigurationProperty Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionConfigurationUnmarshaller"> <summary> Response Unmarshaller for ActionConfiguration Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionContextUnmarshaller"> <summary> Response Unmarshaller for ActionContext Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionDeclarationMarshaller"> <summary> ActionDeclaration Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionDeclarationUnmarshaller"> <summary> Response Unmarshaller for ActionDeclaration Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionExecutionUnmarshaller"> <summary> Response Unmarshaller for ActionExecution Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionRevisionMarshaller"> <summary> ActionRevision Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionRevisionUnmarshaller"> <summary> Response Unmarshaller for ActionRevision Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionStateUnmarshaller"> <summary> Response Unmarshaller for ActionState Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionTypeIdMarshaller"> <summary> ActionTypeId Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionTypeIdUnmarshaller"> <summary> Response Unmarshaller for ActionTypeId Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionTypeSettingsMarshaller"> <summary> ActionTypeSettings Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionTypeSettingsUnmarshaller"> <summary> Response Unmarshaller for ActionTypeSettings Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ActionTypeUnmarshaller"> <summary> Response Unmarshaller for ActionType Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactDetailsMarshaller"> <summary> ArtifactDetails Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactDetailsUnmarshaller"> <summary> Response Unmarshaller for ArtifactDetails Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactLocationUnmarshaller"> <summary> Response Unmarshaller for ArtifactLocation Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactStoreMarshaller"> <summary> ArtifactStore Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactStoreUnmarshaller"> <summary> Response Unmarshaller for ArtifactStore Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ArtifactUnmarshaller"> <summary> Response Unmarshaller for Artifact Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.AWSSessionCredentialsUnmarshaller"> <summary> Response Unmarshaller for AWSSessionCredentials Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.BlockerDeclarationMarshaller"> <summary> BlockerDeclaration Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.BlockerDeclarationUnmarshaller"> <summary> Response Unmarshaller for BlockerDeclaration Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.CreateCustomActionTypeRequestMarshaller"> <summary> CreateCustomActionType Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.CreateCustomActionTypeResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCustomActionType operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.CreatePipelineRequestMarshaller"> <summary> CreatePipeline Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.CreatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePipeline operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.CurrentRevisionMarshaller"> <summary> CurrentRevision Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DeleteCustomActionTypeRequestMarshaller"> <summary> DeleteCustomActionType Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DeleteCustomActionTypeResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCustomActionType operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DeletePipelineRequestMarshaller"> <summary> DeletePipeline Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DeletePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePipeline operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DisableStageTransitionRequestMarshaller"> <summary> DisableStageTransition Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.DisableStageTransitionResponseUnmarshaller"> <summary> Response Unmarshaller for DisableStageTransition operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.EnableStageTransitionRequestMarshaller"> <summary> EnableStageTransition Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.EnableStageTransitionResponseUnmarshaller"> <summary> Response Unmarshaller for EnableStageTransition operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.EncryptionKeyMarshaller"> <summary> EncryptionKey Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.EncryptionKeyUnmarshaller"> <summary> Response Unmarshaller for EncryptionKey Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ErrorDetailsUnmarshaller"> <summary> Response Unmarshaller for ErrorDetails Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ExecutionDetailsMarshaller"> <summary> ExecutionDetails Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.FailureDetailsMarshaller"> <summary> FailureDetails Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetJobDetailsRequestMarshaller"> <summary> GetJobDetails Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetJobDetailsResponseUnmarshaller"> <summary> Response Unmarshaller for GetJobDetails operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetPipelineRequestMarshaller"> <summary> GetPipeline Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetPipelineResponseUnmarshaller"> <summary> Response Unmarshaller for GetPipeline operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetPipelineStateRequestMarshaller"> <summary> GetPipelineState Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetPipelineStateResponseUnmarshaller"> <summary> Response Unmarshaller for GetPipelineState operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetThirdPartyJobDetailsRequestMarshaller"> <summary> GetThirdPartyJobDetails Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.GetThirdPartyJobDetailsResponseUnmarshaller"> <summary> Response Unmarshaller for GetThirdPartyJobDetails operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.InputArtifactMarshaller"> <summary> InputArtifact Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.InputArtifactUnmarshaller"> <summary> Response Unmarshaller for InputArtifact Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.JobDataUnmarshaller"> <summary> Response Unmarshaller for JobData Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.JobDetailsUnmarshaller"> <summary> Response Unmarshaller for JobDetails Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.JobUnmarshaller"> <summary> Response Unmarshaller for Job Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ListActionTypesRequestMarshaller"> <summary> ListActionTypes Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ListActionTypesResponseUnmarshaller"> <summary> Response Unmarshaller for ListActionTypes operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ListPipelinesRequestMarshaller"> <summary> ListPipelines Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ListPipelinesResponseUnmarshaller"> <summary> Response Unmarshaller for ListPipelines operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.OutputArtifactMarshaller"> <summary> OutputArtifact Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.OutputArtifactUnmarshaller"> <summary> Response Unmarshaller for OutputArtifact Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PipelineContextUnmarshaller"> <summary> Response Unmarshaller for PipelineContext Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PipelineDeclarationMarshaller"> <summary> PipelineDeclaration Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PipelineDeclarationUnmarshaller"> <summary> Response Unmarshaller for PipelineDeclaration Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PipelineSummaryUnmarshaller"> <summary> Response Unmarshaller for PipelineSummary Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PollForJobsRequestMarshaller"> <summary> PollForJobs Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PollForJobsResponseUnmarshaller"> <summary> Response Unmarshaller for PollForJobs operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PollForThirdPartyJobsRequestMarshaller"> <summary> PollForThirdPartyJobs Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PollForThirdPartyJobsResponseUnmarshaller"> <summary> Response Unmarshaller for PollForThirdPartyJobs operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutActionRevisionRequestMarshaller"> <summary> PutActionRevision Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutActionRevisionResponseUnmarshaller"> <summary> Response Unmarshaller for PutActionRevision operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutJobFailureResultRequestMarshaller"> <summary> PutJobFailureResult Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutJobFailureResultResponseUnmarshaller"> <summary> Response Unmarshaller for PutJobFailureResult operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutJobSuccessResultRequestMarshaller"> <summary> PutJobSuccessResult Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutJobSuccessResultResponseUnmarshaller"> <summary> Response Unmarshaller for PutJobSuccessResult operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutThirdPartyJobFailureResultRequestMarshaller"> <summary> PutThirdPartyJobFailureResult Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutThirdPartyJobFailureResultResponseUnmarshaller"> <summary> Response Unmarshaller for PutThirdPartyJobFailureResult operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutThirdPartyJobSuccessResultRequestMarshaller"> <summary> PutThirdPartyJobSuccessResult Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.PutThirdPartyJobSuccessResultResponseUnmarshaller"> <summary> Response Unmarshaller for PutThirdPartyJobSuccessResult operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.S3ArtifactLocationUnmarshaller"> <summary> Response Unmarshaller for S3ArtifactLocation Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StageContextUnmarshaller"> <summary> Response Unmarshaller for StageContext Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StageDeclarationMarshaller"> <summary> StageDeclaration Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StageDeclarationUnmarshaller"> <summary> Response Unmarshaller for StageDeclaration Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StageStateUnmarshaller"> <summary> Response Unmarshaller for StageState Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StartPipelineExecutionRequestMarshaller"> <summary> StartPipelineExecution Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.StartPipelineExecutionResponseUnmarshaller"> <summary> Response Unmarshaller for StartPipelineExecution operation </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ThirdPartyJobDataUnmarshaller"> <summary> Response Unmarshaller for ThirdPartyJobData Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ThirdPartyJobDetailsUnmarshaller"> <summary> Response Unmarshaller for ThirdPartyJobDetails Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.ThirdPartyJobUnmarshaller"> <summary> Response Unmarshaller for ThirdPartyJob Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.TransitionStateUnmarshaller"> <summary> Response Unmarshaller for TransitionState Object </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.UpdatePipelineRequestMarshaller"> <summary> UpdatePipeline Request Marshaller </summary> </member> <member name="T:Amazon.CodePipeline.Model.Internal.MarshallTransformations.UpdatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for UpdatePipeline operation </summary> </member> <member name="T:Amazon.CloudHSM.AmazonCloudHSMClient"> <summary> Implementation for accessing CloudHSM AWS CloudHSM Service </summary> </member> <member name="T:Amazon.CloudHSM.IAmazonCloudHSM"> <summary> Interface for accessing CloudHSM AWS CloudHSM Service </summary> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHapg(System.String)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="label">The label of the new high-availability partition group.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg service method.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginCreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndCreateHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateHapg.</param> <returns>Returns a CreateHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest)"> <summary> Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm service method.</param> <returns>The response from the CreateHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginCreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndCreateHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateHsm.</param> <returns>Returns a CreateHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.CreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest)"> <summary> Creates an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient service method.</param> <returns>The response from the CreateLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginCreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndCreateLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLunaClient.</param> <returns>Returns a CreateLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHapg(System.String)"> <summary> Deletes a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to delete.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest)"> <summary> Deletes a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg service method.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDeleteHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteHapg.</param> <returns>Returns a DeleteHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHsm(System.String)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="hsmArn">The ARN of the HSM to delete.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm service method.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDeleteHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteHsm.</param> <returns>Returns a DeleteHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteLunaClient(System.String)"> <summary> Deletes a client. </summary> <param name="clientArn">The ARN of the client to delete.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest)"> <summary> Deletes a client. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient service method.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDeleteLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLunaClient.</param> <returns>Returns a DeleteLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHapg(System.String)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to describe.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg service method.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDescribeHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeHapg.</param> <returns>Returns a DescribeHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHsm(System.String)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="hsmArn">The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm service method.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDescribeHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeHsm.</param> <returns>Returns a DescribeHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.DescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest)"> <summary> Retrieves information about an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient service method.</param> <returns>The response from the DescribeLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginDescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndDescribeLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLunaClient.</param> <returns>Returns a DescribeLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.GetConfig(Amazon.CloudHSM.Model.GetConfigRequest)"> <summary> Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig service method.</param> <returns>The response from the GetConfig service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginGetConfig(Amazon.CloudHSM.Model.GetConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetConfig operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndGetConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetConfig.</param> <returns>Returns a GetConfigResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListAvailableZones"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest)"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones service method.</param> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAvailableZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAvailableZones operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndListAvailableZones(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAvailableZones operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAvailableZones.</param> <returns>Returns a ListAvailableZonesResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHapgs"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest)"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs service method.</param> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListHapgs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListHapgs operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndListHapgs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListHapgs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListHapgs.</param> <returns>Returns a ListHapgsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHsms"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListHsms(Amazon.CloudHSM.Model.ListHsmsRequest)"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHsms service method.</param> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginListHsms(Amazon.CloudHSM.Model.ListHsmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListHsms operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHsms operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListHsms operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndListHsms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListHsms operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListHsms.</param> <returns>Returns a ListHsmsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListLunaClients"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest)"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients service method.</param> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListLunaClients operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListLunaClients operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndListLunaClients(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListLunaClients operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListLunaClients.</param> <returns>Returns a ListLunaClientsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest)"> <summary> Modifies an existing high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg service method.</param> <returns>The response from the ModifyHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndModifyHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyHapg.</param> <returns>Returns a ModifyHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest)"> <summary> Modifies an HSM. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm service method.</param> <returns>The response from the ModifyHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndModifyHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyHsm.</param> <returns>Returns a ModifyHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.ModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest)"> <summary> Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient service method.</param> <returns>The response from the ModifyLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.BeginModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.IAmazonCloudHSM.EndModifyLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyLunaClient.</param> <returns>Returns a ModifyLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Credentials and an AmazonCloudHSMClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.#ctor(System.String,System.String,System.String,Amazon.CloudHSM.AmazonCloudHSMConfig)"> <summary> Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudHSMClient Configuration Object</param> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHapg(System.String)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="label">The label of the new high-availability partition group.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest)"> <summary> Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg service method.</param> <returns>The response from the CreateHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginCreateHapg(Amazon.CloudHSM.Model.CreateHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndCreateHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateHapg.</param> <returns>Returns a CreateHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest)"> <summary> Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm service method.</param> <returns>The response from the CreateHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginCreateHsm(Amazon.CloudHSM.Model.CreateHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndCreateHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateHsm.</param> <returns>Returns a CreateHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.CreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest)"> <summary> Creates an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient service method.</param> <returns>The response from the CreateLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginCreateLunaClient(Amazon.CloudHSM.Model.CreateLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndCreateLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLunaClient.</param> <returns>Returns a CreateLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHapg(System.String)"> <summary> Deletes a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to delete.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest)"> <summary> Deletes a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg service method.</param> <returns>The response from the DeleteHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDeleteHapg(Amazon.CloudHSM.Model.DeleteHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDeleteHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteHapg.</param> <returns>Returns a DeleteHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHsm(System.String)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="hsmArn">The ARN of the HSM to delete.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest)"> <summary> Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm service method.</param> <returns>The response from the DeleteHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDeleteHsm(Amazon.CloudHSM.Model.DeleteHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDeleteHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteHsm.</param> <returns>Returns a DeleteHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteLunaClient(System.String)"> <summary> Deletes a client. </summary> <param name="clientArn">The ARN of the client to delete.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest)"> <summary> Deletes a client. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient service method.</param> <returns>The response from the DeleteLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDeleteLunaClient(Amazon.CloudHSM.Model.DeleteLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDeleteLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLunaClient.</param> <returns>Returns a DeleteLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHapg(System.String)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="hapgArn">The ARN of the high-availability partition group to describe.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest)"> <summary> Retrieves information about a high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg service method.</param> <returns>The response from the DescribeHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDescribeHapg(Amazon.CloudHSM.Model.DescribeHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDescribeHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeHapg.</param> <returns>Returns a DescribeHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHsm(System.String)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="hsmArn">The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest)"> <summary> Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm service method.</param> <returns>The response from the DescribeHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDescribeHsm(Amazon.CloudHSM.Model.DescribeHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDescribeHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeHsm.</param> <returns>Returns a DescribeHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.DescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest)"> <summary> Retrieves information about an HSM client. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient service method.</param> <returns>The response from the DescribeLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginDescribeLunaClient(Amazon.CloudHSM.Model.DescribeLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndDescribeLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLunaClient.</param> <returns>Returns a DescribeLunaClientResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.GetConfig(Amazon.CloudHSM.Model.GetConfigRequest)"> <summary> Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig service method.</param> <returns>The response from the GetConfig service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginGetConfig(Amazon.CloudHSM.Model.GetConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetConfig operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConfig operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetConfig operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndGetConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetConfig operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetConfig.</param> <returns>Returns a GetConfigResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListAvailableZones"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest)"> <summary> Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones service method.</param> <returns>The response from the ListAvailableZones service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginListAvailableZones(Amazon.CloudHSM.Model.ListAvailableZonesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListAvailableZones operation. </summary> <param name="request">Container for the necessary parameters to execute the ListAvailableZones operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListAvailableZones operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndListAvailableZones(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListAvailableZones operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListAvailableZones.</param> <returns>Returns a ListAvailableZonesResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHapgs"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest)"> <summary> Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs service method.</param> <returns>The response from the ListHapgs service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginListHapgs(Amazon.CloudHSM.Model.ListHapgsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListHapgs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHapgs operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListHapgs operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndListHapgs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListHapgs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListHapgs.</param> <returns>Returns a ListHapgsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHsms"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListHsms(Amazon.CloudHSM.Model.ListHsmsRequest)"> <summary> Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListHsms service method.</param> <returns>The response from the ListHsms service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginListHsms(Amazon.CloudHSM.Model.ListHsmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListHsms operation. </summary> <param name="request">Container for the necessary parameters to execute the ListHsms operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListHsms operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndListHsms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListHsms operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListHsms.</param> <returns>Returns a ListHsmsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListLunaClients"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest)"> <summary> Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients service method.</param> <returns>The response from the ListLunaClients service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginListLunaClients(Amazon.CloudHSM.Model.ListLunaClientsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListLunaClients operation. </summary> <param name="request">Container for the necessary parameters to execute the ListLunaClients operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListLunaClients operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndListLunaClients(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListLunaClients operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListLunaClients.</param> <returns>Returns a ListLunaClientsResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest)"> <summary> Modifies an existing high-availability partition group. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg service method.</param> <returns>The response from the ModifyHapg service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginModifyHapg(Amazon.CloudHSM.Model.ModifyHapgRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyHapg operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHapg operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyHapg operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndModifyHapg(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyHapg operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyHapg.</param> <returns>Returns a ModifyHapgResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest)"> <summary> Modifies an HSM. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm service method.</param> <returns>The response from the ModifyHsm service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> Indicates that an internal error occurred. </exception> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> <exception cref="T:Amazon.CloudHSM.Model.InvalidRequestException"> Indicates that one or more of the request parameters are not valid. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginModifyHsm(Amazon.CloudHSM.Model.ModifyHsmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyHsm operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyHsm operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyHsm operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndModifyHsm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyHsm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyHsm.</param> <returns>Returns a ModifyHsmResult from CloudHSM.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.ModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest)"> <summary> Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient service method.</param> <returns>The response from the ModifyLunaClient service method, as returned by CloudHSM.</returns> <exception cref="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> Indicates that an exception occurred in the AWS CloudHSM service. </exception> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.BeginModifyLunaClient(Amazon.CloudHSM.Model.ModifyLunaClientRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyLunaClient operation on AmazonCloudHSMClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyLunaClient operation.</returns> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMClient.EndModifyLunaClient(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyLunaClient operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyLunaClient.</param> <returns>Returns a ModifyLunaClientResult from CloudHSM.</returns> </member> <member name="T:Amazon.CloudHSM.AmazonCloudHSMConfig"> <summary> Configuration for accessing Amazon CloudHSM service </summary> </member> <member name="M:Amazon.CloudHSM.AmazonCloudHSMConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudHSM.AmazonCloudHSMConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudHSM.AmazonCloudHSMConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudHSM.ClientVersion"> <summary> Constants used for properties of type ClientVersion. </summary> </member> <member name="F:Amazon.CloudHSM.ClientVersion.v5_1"> <summary> Constant v5_1 for ClientVersion </summary> </member> <member name="F:Amazon.CloudHSM.ClientVersion.v5_3"> <summary> Constant v5_3 for ClientVersion </summary> </member> <member name="M:Amazon.CloudHSM.ClientVersion.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudHSM.ClientVersion.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudHSM.CloudHsmObjectState"> <summary> Constants used for properties of type CloudHsmObjectState. </summary> </member> <member name="F:Amazon.CloudHSM.CloudHsmObjectState.DEGRADED"> <summary> Constant DEGRADED for CloudHsmObjectState </summary> </member> <member name="F:Amazon.CloudHSM.CloudHsmObjectState.READY"> <summary> Constant READY for CloudHsmObjectState </summary> </member> <member name="F:Amazon.CloudHSM.CloudHsmObjectState.UPDATING"> <summary> Constant UPDATING for CloudHsmObjectState </summary> </member> <member name="M:Amazon.CloudHSM.CloudHsmObjectState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudHSM.CloudHsmObjectState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudHSM.HsmStatus"> <summary> Constants used for properties of type HsmStatus. </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.DEGRADED"> <summary> Constant DEGRADED for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.PENDING"> <summary> Constant PENDING for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.RUNNING"> <summary> Constant RUNNING for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.SUSPENDED"> <summary> Constant SUSPENDED for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.TERMINATED"> <summary> Constant TERMINATED for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.TERMINATING"> <summary> Constant TERMINATING for HsmStatus </summary> </member> <member name="F:Amazon.CloudHSM.HsmStatus.UPDATING"> <summary> Constant UPDATING for HsmStatus </summary> </member> <member name="M:Amazon.CloudHSM.HsmStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudHSM.HsmStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudHSM.SubscriptionType"> <summary> Constants used for properties of type SubscriptionType. </summary> </member> <member name="F:Amazon.CloudHSM.SubscriptionType.PRODUCTION"> <summary> Constant PRODUCTION for SubscriptionType </summary> </member> <member name="M:Amazon.CloudHSM.SubscriptionType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudHSM.SubscriptionType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientRequest"> <summary> Container for the parameters to the AddHAPartitionGroupToClient operation. Adds an HAPG to a Client. </summary> </member> <member name="T:Amazon.CloudHSM.AmazonCloudHSMRequest"> <summary> Base class for CloudHSM operation requests. </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientResponse"> <summary> Configuration for accessing Amazon AddHAPartitionGroupToClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientResult.HAPartitionGroupList"> <summary> Gets and sets the property HAPartitionGroupList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddHAPartitionGroupToClientResponse.AddHAPartitionGroupToClientResult"> <summary> Gets and sets the AddHAPartitionGroupToClientResult property. Represents the output of a AddHAPartitionGroupToClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupRequest"> <summary> Container for the parameters to the AddPartitionToHAPartitionGroup operation. Adds a partition to an HA partition group </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupResponse"> <summary> Configuration for accessing Amazon AddPartitionToHAPartitionGroup service </summary> </member> <member name="T:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupResult.PartitionList"> <summary> Gets and sets the property PartitionList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.AddPartitionToHAPartitionGroupResponse.AddPartitionToHAPartitionGroupResult"> <summary> Gets and sets the AddPartitionToHAPartitionGroupResult property. Represents the output of a AddPartitionToHAPartitionGroup operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CloudHsmInternalException"> <summary> CloudHSM exception </summary> </member> <member name="M:Amazon.CloudHSM.Model.CloudHsmInternalException.#ctor(System.String)"> <summary> Constructs a new CloudHsmInternalException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudHSM.Model.CloudHsmServiceException"> <summary> CloudHSM exception </summary> </member> <member name="M:Amazon.CloudHSM.Model.CloudHsmServiceException.#ctor(System.String)"> <summary> Constructs a new CloudHsmServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmRequest"> <summary> Container for the parameters to the ConvertOnDemandHsmToUpfrontHsm operation. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmRequest.HsmArn"> <summary> Gets and sets the property HsmArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmResponse"> <summary> Configuration for accessing Amazon ConvertOnDemandHsmToUpfrontHsm service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmResult.HsmArn"> <summary> Gets and sets the property HsmArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ConvertOnDemandHsmToUpfrontHsmResponse.ConvertOnDemandHsmToUpfrontHsmResult"> <summary> Gets and sets the ConvertOnDemandHsmToUpfrontHsmResult property. Represents the output of a ConvertOnDemandHsmToUpfrontHsm operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateClientRequest"> <summary> Container for the parameters to the CreateClient operation. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateClientRequest.Certificate"> <summary> Gets and sets the property Certificate. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateClientRequest.Label"> <summary> Gets and sets the property Label. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateClientResponse"> <summary> Configuration for accessing Amazon CreateClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateClientResponse.CreateClientResult"> <summary> Gets and sets the CreateClientResult property. Represents the output of a CreateClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHAPartitionGroupRequest"> <summary> Container for the parameters to the CreateHAPartitionGroup operation. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHAPartitionGroupRequest.Label"> <summary> Gets and sets the property Label. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHAPartitionGroupResponse"> <summary> Configuration for accessing Amazon CreateHAPartitionGroup service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHAPartitionGroupResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHAPartitionGroupResult.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHAPartitionGroupResponse.CreateHAPartitionGroupResult"> <summary> Gets and sets the CreateHAPartitionGroupResult property. Represents the output of a CreateHAPartitionGroup operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHapgRequest"> <summary> Container for the parameters to the CreateHapg operation. Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHapgRequest.Label"> <summary> Gets and sets the property Label. <para> The label of the new high-availability partition group. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHapgResponse"> <summary> Configuration for accessing Amazon CreateHapg service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHapgResult"> <summary> Contains the output of the <a>CreateHAPartitionGroup</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHapgResult.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHapgResponse.CreateHapgResult"> <summary> Gets and sets the CreateHapgResult property. Represents the output of a CreateHapg operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHsmRequest"> <summary> Container for the parameters to the CreateHsm operation. Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.EniIp"> <summary> Gets and sets the property EniIp. <para> The IP address to assign to the HSM's ENI. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.ExternalId"> <summary> Gets and sets the property ExternalId. <para> The external ID from <b>IamRoleArn</b>, if present. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.IamRoleArn"> <summary> Gets and sets the property IamRoleArn. <para> The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.SshKey"> <summary> Gets and sets the property SshKey. <para> The SSH public key to install on the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The identifier of the subnet in your VPC in which to place the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.SubscriptionType"> <summary> Gets and sets the property SubscriptionType. <para> The subscription type. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmRequest.SyslogIp"> <summary> Gets and sets the property SyslogIp. <para> The IP address for the syslog monitoring server. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHsmResponse"> <summary> Configuration for accessing Amazon CreateHsm service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateHsmResult"> <summary> Contains the output of the <a>CreateHsm</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmResult.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateHsmResponse.CreateHsmResult"> <summary> Gets and sets the CreateHsmResult property. Represents the output of a CreateHsm operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateLunaClientRequest"> <summary> Container for the parameters to the CreateLunaClient operation. Creates an HSM client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateLunaClientRequest.Certificate"> <summary> Gets and sets the property Certificate. <para> The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateLunaClientRequest.Label"> <summary> Gets and sets the property Label. <para> The label for the client. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateLunaClientResponse"> <summary> Configuration for accessing Amazon CreateLunaClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreateLunaClientResult"> <summary> Contains the output of the <a>CreateLunaClient</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateLunaClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreateLunaClientResponse.CreateLunaClientResult"> <summary> Gets and sets the CreateLunaClientResult property. Represents the output of a CreateLunaClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreatePartitionRequest"> <summary> Container for the parameters to the CreatePartition operation. DEPRECATED. Use RegisterPartition instead. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreatePartitionRequest.HsmArn"> <summary> Gets and sets the property HsmArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreatePartitionRequest.PartitionLabel"> <summary> Gets and sets the property PartitionLabel. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreatePartitionRequest.PartitionSerial"> <summary> Gets and sets the property PartitionSerial. </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreatePartitionResponse"> <summary> Configuration for accessing Amazon CreatePartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.CreatePartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreatePartitionResult.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.CreatePartitionResponse.CreatePartitionResult"> <summary> Gets and sets the CreatePartitionResult property. Represents the output of a CreatePartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteClientRequest"> <summary> Container for the parameters to the DeleteClient operation. Delete a client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteClientResponse"> <summary> Configuration for accessing Amazon DeleteClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteClientResult.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteClientResponse.DeleteClientResult"> <summary> Gets and sets the DeleteClientResult property. Represents the output of a DeleteClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHAPartitionGroupRequest"> <summary> Container for the parameters to the DeleteHAPartitionGroup operation. Delete an HAPartitionGroup </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHAPartitionGroupRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHAPartitionGroupResponse"> <summary> Configuration for accessing Amazon DeleteHAPartitionGroup service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHAPartitionGroupResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHAPartitionGroupResult.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHAPartitionGroupResponse.DeleteHAPartitionGroupResult"> <summary> Gets and sets the DeleteHAPartitionGroupResult property. Represents the output of a DeleteHAPartitionGroup operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHapgRequest"> <summary> Container for the parameters to the DeleteHapg operation. Deletes a high-availability partition group. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHapgRequest.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group to delete. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHapgResponse"> <summary> Configuration for accessing Amazon DeleteHapg service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHapgResult"> <summary> Contains the output of the <a>DeleteHapg</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHapgResult.Status"> <summary> Gets and sets the property Status. <para> The status of the action. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHapgResponse.DeleteHapgResult"> <summary> Gets and sets the DeleteHapgResult property. Represents the output of a DeleteHapg operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHsmRequest"> <summary> Container for the parameters to the DeleteHsm operation. Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHsmRequest.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM to delete. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHsmResponse"> <summary> Configuration for accessing Amazon DeleteHsm service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteHsmResult"> <summary> Contains the output of the <a>DeleteHsm</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHsmResult.Status"> <summary> Gets and sets the property Status. <para> The status of the action. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteHsmResponse.DeleteHsmResult"> <summary> Gets and sets the DeleteHsmResult property. Represents the output of a DeleteHsm operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteLunaClientRequest"> <summary> Container for the parameters to the DeleteLunaClient operation. Deletes a client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteLunaClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client to delete. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteLunaClientResponse"> <summary> Configuration for accessing Amazon DeleteLunaClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeleteLunaClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteLunaClientResult.Status"> <summary> Gets and sets the property Status. <para> The status of the action. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeleteLunaClientResponse.DeleteLunaClientResult"> <summary> Gets and sets the DeleteLunaClientResult property. Represents the output of a DeleteLunaClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeletePartitionRequest"> <summary> Container for the parameters to the DeletePartition operation. DEPRECATED. Use DeregisterPartition instead. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeletePartitionRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeletePartitionResponse"> <summary> Configuration for accessing Amazon DeletePartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeletePartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeletePartitionResult.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeletePartitionResponse.DeletePartitionResult"> <summary> Gets and sets the DeletePartitionResult property. Represents the output of a DeletePartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeregisterPartitionRequest"> <summary> Container for the parameters to the DeregisterPartition operation. Deregister a Partition </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeregisterPartitionRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeregisterPartitionResponse"> <summary> Configuration for accessing Amazon DeregisterPartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DeregisterPartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeregisterPartitionResult.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DeregisterPartitionResponse.DeregisterPartitionResult"> <summary> Gets and sets the DeregisterPartitionResult property. Represents the output of a DeregisterPartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeClientRequest"> <summary> Container for the parameters to the DescribeClient operation. Describes a client </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeClientResponse"> <summary> Configuration for accessing Amazon DescribeClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.Certificate"> <summary> Gets and sets the property Certificate. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.HAPartitionGroupList"> <summary> Gets and sets the property HAPartitionGroupList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.Label"> <summary> Gets and sets the property Label. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.LastModifiedTimestamp"> <summary> Gets and sets the property LastModifiedTimestamp. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.PartitionList"> <summary> Gets and sets the property PartitionList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.State"> <summary> Gets and sets the property State. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResult.StateDetails"> <summary> Gets and sets the property StateDetails. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeClientResponse.DescribeClientResult"> <summary> Gets and sets the DescribeClientResult property. Represents the output of a DescribeClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHAPartitionGroupRequest"> <summary> Container for the parameters to the DescribeHAPartitionGroup operation. Describes an HA partition group </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResponse"> <summary> Configuration for accessing Amazon DescribeHAPartitionGroup service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.ClientList"> <summary> Gets and sets the property ClientList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.HAPartitionGroupSerial"> <summary> Gets and sets the property HAPartitionGroupSerial. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.Label"> <summary> Gets and sets the property Label. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.LastModifiedTimestamp"> <summary> Gets and sets the property LastModifiedTimestamp. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.PartitionList"> <summary> Gets and sets the property PartitionList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.State"> <summary> Gets and sets the property State. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResult.StateDetails"> <summary> Gets and sets the property StateDetails. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHAPartitionGroupResponse.DescribeHAPartitionGroupResult"> <summary> Gets and sets the DescribeHAPartitionGroupResult property. Represents the output of a DescribeHAPartitionGroup operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHapgRequest"> <summary> Container for the parameters to the DescribeHapg operation. Retrieves information about a high-availability partition group. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgRequest.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group to describe. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHapgResponse"> <summary> Configuration for accessing Amazon DescribeHapg service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHapgResult"> <summary> Contains the output of the <a>DescribeHapg</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.HapgSerial"> <summary> Gets and sets the property HapgSerial. <para> The serial number of the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.HsmsLastActionFailed"> <summary> Gets and sets the property HsmsLastActionFailed. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.HsmsPendingDeletion"> <summary> Gets and sets the property HsmsPendingDeletion. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.HsmsPendingRegistration"> <summary> Gets and sets the property HsmsPendingRegistration. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.Label"> <summary> Gets and sets the property Label. <para> The label for the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.LastModifiedTimestamp"> <summary> Gets and sets the property LastModifiedTimestamp. <para> The date and time the high-availability partition group was last modified. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.PartitionSerialList"> <summary> Gets and sets the property PartitionSerialList. <para> The list of partition serial numbers that belong to the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResult.State"> <summary> Gets and sets the property State. <para> The state of the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHapgResponse.DescribeHapgResult"> <summary> Gets and sets the DescribeHapgResult property. Represents the output of a DescribeHapg operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHsmRequest"> <summary> Container for the parameters to the DescribeHsm operation. Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmRequest.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmRequest.HsmSerialNumber"> <summary> Gets and sets the property HsmSerialNumber. <para> The serial number of the HSM. Either the <i>HsmArn</i> or the <i>HsmSerialNumber</i> parameter must be specified. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHsmResponse"> <summary> Configuration for accessing Amazon DescribeHsm service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeHsmResult"> <summary> Contains the output of the <a>DescribeHsm</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone that the HSM is in. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.EniId"> <summary> Gets and sets the property EniId. <para> The identifier of the elastic network interface (ENI) attached to the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.EniIp"> <summary> Gets and sets the property EniIp. <para> The IP address assigned to the HSM's ENI. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.HsmType"> <summary> Gets and sets the property HsmType. <para> The HSM model type. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.IamRoleArn"> <summary> Gets and sets the property IamRoleArn. <para> The ARN of the IAM role assigned to the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.Partitions"> <summary> Gets and sets the property Partitions. <para> The list of partitions on the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SerialNumber"> <summary> Gets and sets the property SerialNumber. <para> The serial number of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.ServerCertLastUpdated"> <summary> Gets and sets the property ServerCertLastUpdated. <para> The date and time the server certificate was last updated. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.ServerCertUri"> <summary> Gets and sets the property ServerCertUri. <para> The URI of the certificate server. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SoftwareVersion"> <summary> Gets and sets the property SoftwareVersion. <para> The HSM software version. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SshKeyLastUpdated"> <summary> Gets and sets the property SshKeyLastUpdated. <para> The date and time the SSH key was last updated. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SshPublicKey"> <summary> Gets and sets the property SshPublicKey. <para> The public SSH key. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.Status"> <summary> Gets and sets the property Status. <para> The status of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.StatusDetails"> <summary> Gets and sets the property StatusDetails. <para> Contains additional information about the status of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The identifier of the subnet the HSM is in. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SubscriptionEndDate"> <summary> Gets and sets the property SubscriptionEndDate. <para> The subscription end date. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SubscriptionStartDate"> <summary> Gets and sets the property SubscriptionStartDate. <para> The subscription start date. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.SubscriptionType"> <summary> Gets and sets the property SubscriptionType. <para> The subscription type. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.VendorName"> <summary> Gets and sets the property VendorName. <para> The name of the HSM vendor. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResult.VpcId"> <summary> Gets and sets the property VpcId. <para> The identifier of the VPC that the HSM is in. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeHsmResponse.DescribeHsmResult"> <summary> Gets and sets the DescribeHsmResult property. Represents the output of a DescribeHsm operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeLunaClientRequest"> <summary> Container for the parameters to the DescribeLunaClient operation. Retrieves information about an HSM client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientRequest.CertificateFingerprint"> <summary> Gets and sets the property CertificateFingerprint. <para> The certificate fingerprint. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeLunaClientResponse"> <summary> Configuration for accessing Amazon DescribeLunaClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribeLunaClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResult.Certificate"> <summary> Gets and sets the property Certificate. <para> The certificate installed on the HSMs used by this client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResult.CertificateFingerprint"> <summary> Gets and sets the property CertificateFingerprint. <para> The certificate fingerprint. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResult.Label"> <summary> Gets and sets the property Label. <para> The label of the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResult.LastModifiedTimestamp"> <summary> Gets and sets the property LastModifiedTimestamp. <para> The date and time the client was last modified. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribeLunaClientResponse.DescribeLunaClientResult"> <summary> Gets and sets the DescribeLunaClientResult property. Represents the output of a DescribeLunaClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribePartitionRequest"> <summary> Container for the parameters to the DescribePartition operation. Describes a partition </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribePartitionResponse"> <summary> Configuration for accessing Amazon DescribePartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.DescribePartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.ClientList"> <summary> Gets and sets the property ClientList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.HAPartitionGroupList"> <summary> Gets and sets the property HAPartitionGroupList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.HsmArn"> <summary> Gets and sets the property HsmArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.LastModifiedTimestamp"> <summary> Gets and sets the property LastModifiedTimestamp. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.PartitionLabel"> <summary> Gets and sets the property PartitionLabel. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.PartitionSerial"> <summary> Gets and sets the property PartitionSerial. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.State"> <summary> Gets and sets the property State. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResult.StateDetails"> <summary> Gets and sets the property StateDetails. </summary> </member> <member name="P:Amazon.CloudHSM.Model.DescribePartitionResponse.DescribePartitionResult"> <summary> Gets and sets the DescribePartitionResult property. Represents the output of a DescribePartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetClientConfigurationRequest"> <summary> Container for the parameters to the GetClientConfiguration operation. Get the configuration for aa Client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationRequest.ClientVersion"> <summary> Gets and sets the property ClientVersion. </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetClientConfigurationResponse"> <summary> Configuration for accessing Amazon GetClientConfiguration service </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetClientConfigurationResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationResult.ConfigCred"> <summary> Gets and sets the property ConfigCred. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationResult.ConfigFile"> <summary> Gets and sets the property ConfigFile. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationResult.ConfigType"> <summary> Gets and sets the property ConfigType. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetClientConfigurationResponse.GetClientConfigurationResult"> <summary> Gets and sets the GetClientConfigurationResult property. Represents the output of a GetClientConfiguration operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetConfigRequest"> <summary> Container for the parameters to the GetConfig operation. Gets the configuration files necessary to connect to all high availability partition groups the client is associated with. </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigRequest.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigRequest.ClientVersion"> <summary> Gets and sets the property ClientVersion. <para> The client version. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigRequest.HapgList"> <summary> Gets and sets the property HapgList. <para> A list of ARNs that identify the high-availability partition groups that are associated with the client. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetConfigResponse"> <summary> Configuration for accessing Amazon GetConfig service </summary> </member> <member name="T:Amazon.CloudHSM.Model.GetConfigResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigResult.ConfigCred"> <summary> Gets and sets the property ConfigCred. <para> The certificate file containing the server.pem files of the HSMs. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigResult.ConfigFile"> <summary> Gets and sets the property ConfigFile. <para> The chrystoki.conf configuration file. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigResult.ConfigType"> <summary> Gets and sets the property ConfigType. <para> The type of credentials. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.GetConfigResponse.GetConfigResult"> <summary> Gets and sets the GetConfigResult property. Represents the output of a GetConfig operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.InvalidRequestException"> <summary> CloudHSM exception </summary> </member> <member name="M:Amazon.CloudHSM.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.CloudHSM.Model.ListAvailableZonesRequest"> <summary> Container for the parameters to the ListAvailableZones operation. Lists the Availability Zones that have available AWS CloudHSM capacity. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListAvailableZonesResponse"> <summary> Configuration for accessing Amazon ListAvailableZones service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListAvailableZonesResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListAvailableZonesResult.AZList"> <summary> Gets and sets the property AZList. <para> The list of Availability Zones that have available AWS CloudHSM capacity. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListAvailableZonesResponse.ListAvailableZonesResult"> <summary> Gets and sets the ListAvailableZonesResult property. Represents the output of a ListAvailableZones operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListClientsRequest"> <summary> Container for the parameters to the ListClients operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListClientsResponse"> <summary> Configuration for accessing Amazon ListClients service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListClientsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListClientsResult.ClientList"> <summary> Gets and sets the property ClientList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListClientsResponse.ListClientsResult"> <summary> Gets and sets the ListClientsResult property. Represents the output of a ListClients operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHAPartitionGroupsRequest"> <summary> Container for the parameters to the ListHAPartitionGroups operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHAPartitionGroupsResponse"> <summary> Configuration for accessing Amazon ListHAPartitionGroups service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHAPartitionGroupsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHAPartitionGroupsResult.HAPartitionGroupList"> <summary> Gets and sets the property HAPartitionGroupList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHAPartitionGroupsResponse.ListHAPartitionGroupsResult"> <summary> Gets and sets the ListHAPartitionGroupsResult property. Represents the output of a ListHAPartitionGroups operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHapgsRequest"> <summary> Container for the parameters to the ListHapgs operation. Lists the high-availability partition groups for the account. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHapgsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>NextToken</i> value from a previous call to <a>ListHapgs</a>. Pass null if this is the first call. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHapgsResponse"> <summary> Configuration for accessing Amazon ListHapgs service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHapgsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHapgsResult.HapgList"> <summary> Gets and sets the property HapgList. <para> The list of high-availability partition groups. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHapgsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this value to <a>ListHapgs</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHapgsResponse.ListHapgsResult"> <summary> Gets and sets the ListHapgsResult property. Represents the output of a ListHapgs operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHsmsRequest"> <summary> Container for the parameters to the ListHsms operation. Retrieves the identifiers of all of the HSMs provisioned for the current customer. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHsmsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>NextToken</i> value from a previous call to <a>ListHsms</a>. Pass null if this is the first call. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHsmsResponse"> <summary> Configuration for accessing Amazon ListHsms service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListHsmsResult"> <summary> Contains the output of the <a>ListHsms</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHsmsResult.HsmList"> <summary> Gets and sets the property HsmList. <para> The list of ARNs that identify the HSMs. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHsmsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this value to <a>ListHsms</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListHsmsResponse.ListHsmsResult"> <summary> Gets and sets the ListHsmsResult property. Represents the output of a ListHsms operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListLunaClientsRequest"> <summary> Container for the parameters to the ListLunaClients operation. Lists all of the clients. <para> This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListLunaClientsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>NextToken</i> value from a previous call to <a>ListLunaClients</a>. Pass null if this is the first call. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListLunaClientsResponse"> <summary> Configuration for accessing Amazon ListLunaClients service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListLunaClientsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListLunaClientsResult.ClientList"> <summary> Gets and sets the property ClientList. <para> The list of clients. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListLunaClientsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this to <a>ListLunaClients</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListLunaClientsResponse.ListLunaClientsResult"> <summary> Gets and sets the ListLunaClientsResult property. Represents the output of a ListLunaClients operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListPartitionsRequest"> <summary> Container for the parameters to the ListPartitions operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListPartitionsResponse"> <summary> Configuration for accessing Amazon ListPartitions service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ListPartitionsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListPartitionsResult.PartitionList"> <summary> Gets and sets the property PartitionList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ListPartitionsResponse.ListPartitionsResult"> <summary> Gets and sets the ListPartitionsResult property. Represents the output of a ListPartitions operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyClientRequest"> <summary> Container for the parameters to the ModifyClient operation. Modifies a client's attributes </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyClientRequest.Certificate"> <summary> Gets and sets the property Certificate. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyClientResponse"> <summary> Configuration for accessing Amazon ModifyClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyClientResponse.ModifyClientResult"> <summary> Gets and sets the ModifyClientResult property. Represents the output of a ModifyClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHapgRequest"> <summary> Container for the parameters to the ModifyHapg operation. Modifies an existing high-availability partition group. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHapgRequest.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group to modify. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHapgRequest.Label"> <summary> Gets and sets the property Label. <para> The new label for the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHapgRequest.PartitionSerialList"> <summary> Gets and sets the property PartitionSerialList. <para> The list of partition serial numbers to make members of the high-availability partition group. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHapgResponse"> <summary> Configuration for accessing Amazon ModifyHapg service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHapgResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHapgResult.HapgArn"> <summary> Gets and sets the property HapgArn. <para> The ARN of the high-availability partition group. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHapgResponse.ModifyHapgResult"> <summary> Gets and sets the ModifyHapgResult property. Represents the output of a ModifyHapg operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHsmRequest"> <summary> Container for the parameters to the ModifyHsm operation. Modifies an HSM. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.EniIp"> <summary> Gets and sets the property EniIp. <para> The new IP address for the elastic network interface attached to the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.ExternalId"> <summary> Gets and sets the property ExternalId. <para> The new external ID. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM to modify. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.IamRoleArn"> <summary> Gets and sets the property IamRoleArn. <para> The new IAM role ARN. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The new identifier of the subnet that the HSM is in. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmRequest.SyslogIp"> <summary> Gets and sets the property SyslogIp. <para> The new IP address for the syslog monitoring server. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHsmResponse"> <summary> Configuration for accessing Amazon ModifyHsm service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyHsmResult"> <summary> Contains the output of the <a>ModifyHsm</a> action. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmResult.HsmArn"> <summary> Gets and sets the property HsmArn. <para> The ARN of the HSM. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyHsmResponse.ModifyHsmResult"> <summary> Gets and sets the ModifyHsmResult property. Represents the output of a ModifyHsm operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyLunaClientRequest"> <summary> Container for the parameters to the ModifyLunaClient operation. Modifies the certificate used by the client. <para> This action can potentially start a workflow to install the new certificate on the client's HSMs. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyLunaClientRequest.Certificate"> <summary> Gets and sets the property Certificate. <para> The new certificate for the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyLunaClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyLunaClientResponse"> <summary> Configuration for accessing Amazon ModifyLunaClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyLunaClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyLunaClientResult.ClientArn"> <summary> Gets and sets the property ClientArn. <para> The ARN of the client. </para> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyLunaClientResponse.ModifyLunaClientResult"> <summary> Gets and sets the ModifyLunaClientResult property. Represents the output of a ModifyLunaClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyPartitionRequest"> <summary> Container for the parameters to the ModifyPartition operation. Modifies a partition's attributes </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyPartitionRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyPartitionRequest.PartitionLabel"> <summary> Gets and sets the property PartitionLabel. </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyPartitionResponse"> <summary> Configuration for accessing Amazon ModifyPartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.ModifyPartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyPartitionResult.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.ModifyPartitionResponse.ModifyPartitionResult"> <summary> Gets and sets the ModifyPartitionResult property. Represents the output of a ModifyPartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RegisterPartitionRequest"> <summary> Container for the parameters to the RegisterPartition operation. Creates a partition in our internal representation of the customer's system </summary> </member> <member name="P:Amazon.CloudHSM.Model.RegisterPartitionRequest.HsmArn"> <summary> Gets and sets the property HsmArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RegisterPartitionRequest.PartitionLabel"> <summary> Gets and sets the property PartitionLabel. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RegisterPartitionRequest.PartitionSerial"> <summary> Gets and sets the property PartitionSerial. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RegisterPartitionResponse"> <summary> Configuration for accessing Amazon RegisterPartition service </summary> </member> <member name="T:Amazon.CloudHSM.Model.RegisterPartitionResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.RegisterPartitionResult.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RegisterPartitionResponse.RegisterPartitionResult"> <summary> Gets and sets the RegisterPartitionResult property. Represents the output of a RegisterPartition operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientRequest"> <summary> Container for the parameters to the RemoveHAPartitionGroupFromClient operation. Removes an HAPG from a Client. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientRequest.ClientArn"> <summary> Gets and sets the property ClientArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientResponse"> <summary> Configuration for accessing Amazon RemoveHAPartitionGroupFromClient service </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientResult.HAPartitionGroupList"> <summary> Gets and sets the property HAPartitionGroupList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemoveHAPartitionGroupFromClientResponse.RemoveHAPartitionGroupFromClientResult"> <summary> Gets and sets the RemoveHAPartitionGroupFromClientResult property. Represents the output of a RemoveHAPartitionGroupFromClient operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupRequest"> <summary> Container for the parameters to the RemovePartitionFromHAPartitionGroup operation. Adds a partition to an HA partition group </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupRequest.HAPartitionGroupArn"> <summary> Gets and sets the property HAPartitionGroupArn. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupRequest.PartitionArn"> <summary> Gets and sets the property PartitionArn. </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupResponse"> <summary> Configuration for accessing Amazon RemovePartitionFromHAPartitionGroup service </summary> </member> <member name="T:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupResult"> <summary> </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupResult.PartitionList"> <summary> Gets and sets the property PartitionList. </summary> </member> <member name="P:Amazon.CloudHSM.Model.RemovePartitionFromHAPartitionGroupResponse.RemovePartitionFromHAPartitionGroupResult"> <summary> Gets and sets the RemovePartitionFromHAPartitionGroupResult property. Represents the output of a RemovePartitionFromHAPartitionGroup operation. </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.AddHAPartitionGroupToClientRequestMarshaller"> <summary> AddHAPartitionGroupToClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.AddHAPartitionGroupToClientResponseUnmarshaller"> <summary> Response Unmarshaller for AddHAPartitionGroupToClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.AddPartitionToHAPartitionGroupRequestMarshaller"> <summary> AddPartitionToHAPartitionGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.AddPartitionToHAPartitionGroupResponseUnmarshaller"> <summary> Response Unmarshaller for AddPartitionToHAPartitionGroup operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ConvertOnDemandHsmToUpfrontHsmRequestMarshaller"> <summary> ConvertOnDemandHsmToUpfrontHsm Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ConvertOnDemandHsmToUpfrontHsmResponseUnmarshaller"> <summary> Response Unmarshaller for ConvertOnDemandHsmToUpfrontHsm operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateClientRequestMarshaller"> <summary> CreateClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateClientResponseUnmarshaller"> <summary> Response Unmarshaller for CreateClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHAPartitionGroupRequestMarshaller"> <summary> CreateHAPartitionGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHAPartitionGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateHAPartitionGroup operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHapgRequestMarshaller"> <summary> CreateHapg Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHapgResponseUnmarshaller"> <summary> Response Unmarshaller for CreateHapg operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHsmRequestMarshaller"> <summary> CreateHsm Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateHsmResponseUnmarshaller"> <summary> Response Unmarshaller for CreateHsm operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateLunaClientRequestMarshaller"> <summary> CreateLunaClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreateLunaClientResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLunaClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreatePartitionRequestMarshaller"> <summary> CreatePartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.CreatePartitionResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteClientRequestMarshaller"> <summary> DeleteClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteClientResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHAPartitionGroupRequestMarshaller"> <summary> DeleteHAPartitionGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHAPartitionGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteHAPartitionGroup operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHapgRequestMarshaller"> <summary> DeleteHapg Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHapgResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteHapg operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHsmRequestMarshaller"> <summary> DeleteHsm Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteHsmResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteHsm operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteLunaClientRequestMarshaller"> <summary> DeleteLunaClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeleteLunaClientResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLunaClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeletePartitionRequestMarshaller"> <summary> DeletePartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeletePartitionResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeregisterPartitionRequestMarshaller"> <summary> DeregisterPartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DeregisterPartitionResponseUnmarshaller"> <summary> Response Unmarshaller for DeregisterPartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeClientRequestMarshaller"> <summary> DescribeClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeClientResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHAPartitionGroupRequestMarshaller"> <summary> DescribeHAPartitionGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHAPartitionGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeHAPartitionGroup operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHapgRequestMarshaller"> <summary> DescribeHapg Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHapgResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeHapg operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHsmRequestMarshaller"> <summary> DescribeHsm Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeHsmResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeHsm operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeLunaClientRequestMarshaller"> <summary> DescribeLunaClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribeLunaClientResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLunaClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribePartitionRequestMarshaller"> <summary> DescribePartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.DescribePartitionResponseUnmarshaller"> <summary> Response Unmarshaller for DescribePartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.GetClientConfigurationRequestMarshaller"> <summary> GetClientConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.GetClientConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for GetClientConfiguration operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.GetConfigRequestMarshaller"> <summary> GetConfig Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.GetConfigResponseUnmarshaller"> <summary> Response Unmarshaller for GetConfig operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListAvailableZonesRequestMarshaller"> <summary> ListAvailableZones Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListAvailableZonesResponseUnmarshaller"> <summary> Response Unmarshaller for ListAvailableZones operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListClientsRequestMarshaller"> <summary> ListClients Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListClientsResponseUnmarshaller"> <summary> Response Unmarshaller for ListClients operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHAPartitionGroupsRequestMarshaller"> <summary> ListHAPartitionGroups Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHAPartitionGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for ListHAPartitionGroups operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHapgsRequestMarshaller"> <summary> ListHapgs Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHapgsResponseUnmarshaller"> <summary> Response Unmarshaller for ListHapgs operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHsmsRequestMarshaller"> <summary> ListHsms Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListHsmsResponseUnmarshaller"> <summary> Response Unmarshaller for ListHsms operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListLunaClientsRequestMarshaller"> <summary> ListLunaClients Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListLunaClientsResponseUnmarshaller"> <summary> Response Unmarshaller for ListLunaClients operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListPartitionsRequestMarshaller"> <summary> ListPartitions Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ListPartitionsResponseUnmarshaller"> <summary> Response Unmarshaller for ListPartitions operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyClientRequestMarshaller"> <summary> ModifyClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyClientResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyHapgRequestMarshaller"> <summary> ModifyHapg Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyHapgResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyHapg operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyHsmRequestMarshaller"> <summary> ModifyHsm Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyHsmResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyHsm operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyLunaClientRequestMarshaller"> <summary> ModifyLunaClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyLunaClientResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyLunaClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyPartitionRequestMarshaller"> <summary> ModifyPartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.ModifyPartitionResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyPartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RegisterPartitionRequestMarshaller"> <summary> RegisterPartition Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RegisterPartitionResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterPartition operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RemoveHAPartitionGroupFromClientRequestMarshaller"> <summary> RemoveHAPartitionGroupFromClient Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RemoveHAPartitionGroupFromClientResponseUnmarshaller"> <summary> Response Unmarshaller for RemoveHAPartitionGroupFromClient operation </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RemovePartitionFromHAPartitionGroupRequestMarshaller"> <summary> RemovePartitionFromHAPartitionGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudHSM.Model.Internal.MarshallTransformations.RemovePartitionFromHAPartitionGroupResponseUnmarshaller"> <summary> Response Unmarshaller for RemovePartitionFromHAPartitionGroup operation </summary> </member> <member name="T:Amazon.CognitoIdentity.AmazonCognitoIdentityClient"> <summary> Implementation for accessing CognitoIdentity Amazon Cognito <para> Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application. </para> <para> Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials. </para> <para> To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user. </para> <para> Next, make an unsigned call to <a>GetCredentialsForIdentity</a>. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. Assuming your identity pool has been configured via the <a>SetIdentityPoolRoles</a> operation, <code>GetCredentialsForIdentity</code> will return AWS credentials for your use. If your pool has not been configured with <code>SetIdentityPoolRoles</code>, or if you want to follow legacy flow, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials. </para> <para> If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/index.html">AWS Mobile SDK Developer Guide</a>. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.IAmazonCognitoIdentity"> <summary> Interface for accessing CognitoIdentity Amazon Cognito <para> Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application. </para> <para> Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials. </para> <para> To provide end-user credentials, first make an unsigned call to <a>GetId</a>. If the end user is authenticated with one of the supported identity providers, set the <code>Logins</code> map with the identity provider token. <code>GetId</code> returns a unique identifier for the user. </para> <para> Next, make an unsigned call to <a>GetCredentialsForIdentity</a>. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. Assuming your identity pool has been configured via the <a>SetIdentityPoolRoles</a> operation, <code>GetCredentialsForIdentity</code> will return AWS credentials for your use. If your pool has not been configured with <code>SetIdentityPoolRoles</code>, or if you want to follow legacy flow, make an unsigned call to <a>GetOpenIdToken</a>, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same <code>Logins</code> map as the <code>GetId</code> call, as well as the <code>IdentityID</code> originally returned by <code>GetId</code>. The token returned by <code>GetOpenIdToken</code> can be passed to the STS operation <a href="http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html">AssumeRoleWithWebIdentity</a> to retrieve AWS credentials. </para> <para> If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/index.html">AWS Mobile SDK Developer Guide</a>. </para> </summary> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.CreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest)"> <summary> Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> You must use AWS Developer credentials to call this API. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool service method.</param> <returns>The response from the CreateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginCreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndCreateIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateIdentityPool.</param> <returns>Returns a CreateIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest)"> <summary> Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities service method.</param> <returns>The response from the DeleteIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginDeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndDeleteIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIdentities.</param> <returns>Returns a DeleteIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentityPool(System.String)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool service method.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginDeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndDeleteIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIdentityPool.</param> <returns>Returns a DeleteIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentity(System.String)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity service method.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginDescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndDescribeIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentity.</param> <returns>Returns a DescribeIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityPool(System.String)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.DescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool service method.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginDescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndDescribeIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityPool.</param> <returns>Returns a DescribeIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(System.String)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <param name="logins">A set of optional name-value pairs that map provider names to provider tokens.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity service method.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginGetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCredentialsForIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndGetCredentialsForIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCredentialsForIdentity.</param> <returns>Returns a GetCredentialsForIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetId(Amazon.CognitoIdentity.Model.GetIdRequest)"> <summary> Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetId service method.</param> <returns>The response from the GetId service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginGetId(Amazon.CognitoIdentity.Model.GetIdRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetId operation. </summary> <param name="request">Container for the necessary parameters to execute the GetId operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetId operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndGetId(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetId operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetId.</param> <returns>Returns a GetIdResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdentityPoolRoles(System.String)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles service method.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginGetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIdentityPoolRoles operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndGetIdentityPoolRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetIdentityPoolRoles.</param> <returns>Returns a GetIdentityPoolRolesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdToken(System.String)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken service method.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginGetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOpenIdToken operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndGetOpenIdToken(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOpenIdToken.</param> <returns>Returns a GetOpenIdTokenResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.GetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest)"> <summary> Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>. </para> <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.</param> <returns>The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException"> The provided developer user identifier is already registered with Cognito under a different identity ID. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginGetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOpenIdTokenForDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndGetOpenIdTokenForDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOpenIdTokenForDeveloperIdentity.</param> <returns>Returns a GetOpenIdTokenForDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest)"> <summary> Lists the identities in a pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndListIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentities.</param> <returns>Returns a ListIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.ListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest)"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools service method.</param> <returns>The response from the ListIdentityPools service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentityPools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentityPools operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndListIdentityPools(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentityPools operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentityPools.</param> <returns>Returns a ListIdentityPoolsResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.LookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest)"> <summary> Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity service method.</param> <returns>The response from the LookupDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginLookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLookupDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndLookupDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLookupDeveloperIdentity.</param> <returns>Returns a LookupDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.MergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest)"> <summary> Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities service method.</param> <returns>The response from the MergeDeveloperIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginMergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMergeDeveloperIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndMergeDeveloperIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMergeDeveloperIdentities.</param> <returns>Returns a MergeDeveloperIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.SetIdentityPoolRoles(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <param name="roles">The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.SetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest)"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles service method.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginSetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetIdentityPoolRoles operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndSetIdentityPoolRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetIdentityPoolRoles.</param> <returns>Returns a SetIdentityPoolRolesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest)"> <summary> Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.</param> <returns>The response from the UnlinkDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginUnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnlinkDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndUnlinkDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnlinkDeveloperIdentity.</param> <returns>Returns a UnlinkDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest)"> <summary> Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity service method.</param> <returns>The response from the UnlinkIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginUnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnlinkIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndUnlinkIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnlinkIdentity.</param> <returns>Returns a UnlinkIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.UpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest)"> <summary> Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool service method.</param> <returns>The response from the UpdateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.BeginUpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.IAmazonCognitoIdentity.EndUpdateIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateIdentityPool.</param> <returns>Returns a UpdateIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Credentials and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.#ctor(System.String,System.String,System.String,Amazon.CognitoIdentity.AmazonCognitoIdentityConfig)"> <summary> Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCognitoIdentityClient Configuration Object</param> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.CreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest)"> <summary> Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> You must use AWS Developer credentials to call this API. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool service method.</param> <returns>The response from the CreateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginCreateIdentityPool(Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndCreateIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateIdentityPool.</param> <returns>Returns a CreateIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest)"> <summary> Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities service method.</param> <returns>The response from the DeleteIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginDeleteIdentities(Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndDeleteIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIdentities.</param> <returns>Returns a DeleteIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentityPool(System.String)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest)"> <summary> Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool service method.</param> <returns>The response from the DeleteIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginDeleteIdentityPool(Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndDeleteIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIdentityPool.</param> <returns>Returns a DeleteIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentity(System.String)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest)"> <summary> Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity service method.</param> <returns>The response from the DescribeIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginDescribeIdentity(Amazon.CognitoIdentity.Model.DescribeIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndDescribeIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentity.</param> <returns>Returns a DescribeIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityPool(System.String)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.DescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest)"> <summary> Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool service method.</param> <returns>The response from the DescribeIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginDescribeIdentityPool(Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndDescribeIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityPool.</param> <returns>Returns a DescribeIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(System.String)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <param name="logins">A set of optional name-value pairs that map provider names to provider tokens.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest)"> <summary> Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity service method.</param> <returns>The response from the GetCredentialsForIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginGetCredentialsForIdentity(Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCredentialsForIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCredentialsForIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndGetCredentialsForIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCredentialsForIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCredentialsForIdentity.</param> <returns>Returns a GetCredentialsForIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetId(Amazon.CognitoIdentity.Model.GetIdRequest)"> <summary> Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetId service method.</param> <returns>The response from the GetId service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.LimitExceededException"> Thrown when the total number of user pools has exceeded a preset limit. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginGetId(Amazon.CognitoIdentity.Model.GetIdRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetId operation. </summary> <param name="request">Container for the necessary parameters to execute the GetId operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetId operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndGetId(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetId operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetId.</param> <returns>Returns a GetIdResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdentityPoolRoles(System.String)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest)"> <summary> Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles service method.</param> <returns>The response from the GetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginGetIdentityPoolRoles(Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolRoles operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIdentityPoolRoles operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndGetIdentityPoolRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetIdentityPoolRoles operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetIdentityPoolRoles.</param> <returns>Returns a GetIdentityPoolRolesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdToken(System.String)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="identityId">A unique identifier in the format REGION:GUID.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest)"> <summary> Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken service method.</param> <returns>The response from the GetOpenIdToken service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginGetOpenIdToken(Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdToken operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOpenIdToken operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndGetOpenIdToken(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOpenIdToken operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOpenIdToken.</param> <returns>Returns a GetOpenIdTokenResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.GetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest)"> <summary> Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>. </para> <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.</param> <returns>The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException"> The provided developer user identifier is already registered with Cognito under a different identity ID. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginGetOpenIdTokenForDeveloperIdentity(Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetOpenIdTokenForDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndGetOpenIdTokenForDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetOpenIdTokenForDeveloperIdentity.</param> <returns>Returns a GetOpenIdTokenForDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest)"> <summary> Lists the identities in a pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities service method.</param> <returns>The response from the ListIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginListIdentities(Amazon.CognitoIdentity.Model.ListIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndListIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentities.</param> <returns>Returns a ListIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.ListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest)"> <summary> Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools service method.</param> <returns>The response from the ListIdentityPools service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginListIdentityPools(Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentityPools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPools operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentityPools operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndListIdentityPools(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentityPools operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentityPools.</param> <returns>Returns a ListIdentityPoolsResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.LookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest)"> <summary> Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity service method.</param> <returns>The response from the LookupDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginLookupDeveloperIdentity(Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLookupDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndLookupDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the LookupDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLookupDeveloperIdentity.</param> <returns>Returns a LookupDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.MergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest)"> <summary> Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities service method.</param> <returns>The response from the MergeDeveloperIdentities service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginMergeDeveloperIdentities(Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="request">Container for the necessary parameters to execute the MergeDeveloperIdentities operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMergeDeveloperIdentities operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndMergeDeveloperIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MergeDeveloperIdentities operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMergeDeveloperIdentities.</param> <returns>Returns a MergeDeveloperIdentitiesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.SetIdentityPoolRoles(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="identityPoolId">An identity pool ID in the format REGION:GUID.</param> <param name="roles">The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.SetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest)"> <summary> Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles service method.</param> <returns>The response from the SetIdentityPoolRoles service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginSetIdentityPoolRoles(Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolRoles operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetIdentityPoolRoles operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndSetIdentityPoolRoles(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetIdentityPoolRoles operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetIdentityPoolRoles.</param> <returns>Returns a SetIdentityPoolRolesResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest)"> <summary> Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity service method.</param> <returns>The response from the UnlinkDeveloperIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginUnlinkDeveloperIdentity(Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkDeveloperIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnlinkDeveloperIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndUnlinkDeveloperIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnlinkDeveloperIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnlinkDeveloperIdentity.</param> <returns>Returns a UnlinkDeveloperIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest)"> <summary> Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity service method.</param> <returns>The response from the UnlinkIdentity service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> An exception thrown when a dependent service such as Facebook or Twitter is not responding </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginUnlinkIdentity(Amazon.CognitoIdentity.Model.UnlinkIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the UnlinkIdentity operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnlinkIdentity operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndUnlinkIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnlinkIdentity operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnlinkIdentity.</param> <returns>Returns a UnlinkIdentityResult from CognitoIdentity.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.UpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest)"> <summary> Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool service method.</param> <returns>The response from the UpdateIdentityPool service method, as returned by CognitoIdentity.</returns> <exception cref="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InternalErrorException"> Thrown when the service encounters an error during processing the request. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> Thrown for missing or bad input parameter(s). </exception> <exception cref="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> Thrown when a user tries to use a login which is already linked to another account. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> Thrown when the requested resource (for example, a dataset or record) does not exist. </exception> <exception cref="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> Thrown when a request is throttled. </exception> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.BeginUpdateIdentityPool(Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateIdentityPool operation on AmazonCognitoIdentityClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateIdentityPool operation.</returns> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityClient.EndUpdateIdentityPool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateIdentityPool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateIdentityPool.</param> <returns>Returns a UpdateIdentityPoolResult from CognitoIdentity.</returns> </member> <member name="T:Amazon.CognitoIdentity.AmazonCognitoIdentityConfig"> <summary> Configuration for accessing Amazon CognitoIdentity service </summary> </member> <member name="M:Amazon.CognitoIdentity.AmazonCognitoIdentityConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CognitoIdentity.AmazonCognitoIdentityConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CognitoIdentity.AmazonCognitoIdentityConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CognitoIdentity.CognitoAWSCredentials"> <summary> Temporary, short-lived session credentials that are automatically retrieved from Amazon Cognito Identity Service and AWS Security Token Service. Depending on configured Logins, credentials may be authenticated or unauthenticated. </summary> <summary> Temporary, short-lived session credentials that are automatically retrieved from Amazon Cognito Identity Service and AWS Security Token Service. Depending on configured Logins, credentials may be authenticated or unauthenticated. </summary> </member> <member name="T:Amazon.Runtime.RefreshingAWSCredentials"> <summary> Abstract class for automatically refreshing AWS credentials </summary> </member> <member name="T:Amazon.Runtime.AWSCredentials"> <summary> Abstract class that represents a credentials object for AWS services. </summary> </member> <member name="M:Amazon.Runtime.AWSCredentials.GetCredentials"> <summary> Returns a copy of ImmutableCredentials </summary> <returns></returns> </member> <member name="M:Amazon.Runtime.RefreshingAWSCredentials.GetCredentials"> <summary> Returns an instance of ImmutableCredentials for this instance </summary> <returns></returns> </member> <member name="M:Amazon.Runtime.RefreshingAWSCredentials.GenerateNewCredentials"> <summary> When overridden in a derived class, generates new credentials and new expiration date. Called on first credentials request and when expiration date is in the past. </summary> <returns></returns> </member> <member name="M:Amazon.Runtime.RefreshingAWSCredentials.ClearCredentials"> <summary> Clears currently-stored credentials, forcing the next GetCredentials call to generate new credentials. </summary> </member> <member name="P:Amazon.Runtime.RefreshingAWSCredentials.PreemptExpiryTime"> <summary> The time before actual expiration to expire the credentials. Property cannot be set to a negative TimeSpan. </summary> </member> <member name="T:Amazon.Runtime.RefreshingAWSCredentials.CredentialsRefreshState"> <summary> Refresh state container consisting of credentials and the date of the their expiration </summary> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.GetCachedIdentityId"> <summary> Gets the previously cached the identity id retrieved from Cognito. <para> For the Windows Phone and Windows Store version of the SDK the identity id is stored in the Windows.Storage.ApplicationData.Current.LocalSettings or Windows.Storage.ApplicationData.Current.RoamingSettings depending on the IdentityIdCacheMode property. By default IdentityIdCacheMode will be set LocalSettings. </para> <para> For the base .NET 3.5 and .NET 4.5 version of the SDK the identity id is not cached. To support caching the CacheIdentityId, GetCachedIdentityId and ClearIdentityCache methods need to be overridden. </para> </summary> <returns>The previously cached identity id</returns> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.CacheIdentityId(System.String)"> <summary> Caches the identity id retrieved from Cognito. <para> For the Windows Phone and Windows Store version of the SDK the identity id is stored in the Windows.Storage.ApplicationData.Current.LocalSettings or Windows.Storage.ApplicationData.Current.RoamingSettings depending on the IdentityIdCacheMode property. </para> <para> For the base .NET 3.5 and .NET 4.5 version of the SDK the identity id is not cached. To support caching the CacheIdentityId, GetCachedIdentityId and ClearIdentityCache methods need to be overridden. </para> </summary> <param name="identityId">The Cognito identity id to cache</param> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.ClearIdentityCache"> <summary> Clears the currently identity id from the cache. <para> For the base .NET 3.5 and .NET 4.5 version of the SDK the identity id is not cached. To support caching the CacheIdentityId, GetCachedIdentityId and ClearIdentityCache methods need to be overridden. </para> </summary> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.Clear"> <summary> Clears current credentials state. This will reset the IdentityId. </summary> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.RemoveLogin(System.String)"> <summary> Removes a provider from the collection of logins. </summary> <param name="providerName">The provider name for the login (i.e. graph.facebook.com)</param> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.AddLogin(System.String,System.String)"> <summary> Adds a login to be used for authenticated requests. </summary> <param name="providerName">The provider name for the login (i.e. graph.facebook.com)</param> <param name="token">The token provided by the identity provider.</param> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.GetIdentityId"> <summary> Gets the Identity Id corresponding to the credentials retrieved from Cognito. Note: this setting may change during execution. To be notified of its new value, attach a listener to IdentityChangedEvent </summary> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.GetIdentityIdWithCaching"> Checks to see if there is a cached identity id first and falls back to getting a fresh identity id by calling GetIdentityId() </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.ShouldRetry(Amazon.CognitoIdentity.AmazonCognitoIdentityException,Amazon.CognitoIdentity.CognitoAWSCredentials.GetIdentityIdStatus)"> <summary> Checks the exception from a call that used an identity id and determines if the failure was caused by a cached identity id. If it was determined then the cache is cleared and true is return. </summary> <param name="e"></param> <param name="status"></param> <returns></returns> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.#ctor(System.String,Amazon.RegionEndpoint)"> <summary> Constructs a new CognitoAWSCredentials instance, which will use the specified Amazon Cognito identity pool to get short lived session credentials. </summary> <param name="identityPoolId">The Amazon Cogntio identity pool to use</param> <param name="region">Region to use when accessing Amazon Cognito and AWS Security Token Service.</param> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.#ctor(System.String,System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs a new CognitoAWSCredentials instance, which will use the specified Amazon Cognito identity pool to make a requests to the AWS Security Token Service (STS) to request short lived session credentials. </summary> <param name="accountId">The AWS accountId for the account with Amazon Cognito</param> <param name="identityPoolId">The Amazon Cogntio identity pool to use</param> <param name="unAuthRoleArn">The ARN of the IAM Role that will be assumed when unauthenticated</param> <param name="authRoleArn">The ARN of the IAM Role that will be assumed when authenticated</param> <param name="region">Region to use when accessing Amazon Cognito and AWS Security Token Service.</param> </member> <member name="M:Amazon.CognitoIdentity.CognitoAWSCredentials.#ctor(System.String,System.String,System.String,System.String,Amazon.CognitoIdentity.IAmazonCognitoIdentity,Amazon.SecurityToken.IAmazonSecurityTokenService)"> <summary> Constructs a new CognitoAWSCredentials instance, which will use the specified Amazon Cognito identity pool to make a requests to the AWS Security Token Service (STS) to request short lived session credentials. </summary> <param name="accountId">The AWS accountId for the account with Amazon Cognito</param> <param name="identityPoolId">The Amazon Cogntio identity pool to use</param> <param name="unAuthRoleArn">The ARN of the IAM Role that will be assumed when unauthenticated</param> <param name="authRoleArn">The ARN of the IAM Role that will be assumed when authenticated</param> <param name="cibClient">Preconfigured Cognito Identity client to make requests with</param> <param name="stsClient">>Preconfigured STS client to make requests with</param> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.AccountId"> <summary> The AWS accountId for the account with Amazon Cognito </summary> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.IdentityPoolId"> <summary> The Amazon Cogntio identity pool to use </summary> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.UnAuthRoleArn"> <summary> The ARN of the IAM Role that will be assumed when unauthenticated </summary> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.AuthRoleArn"> <summary> The ARN of the IAM Role that will be assumed when authenticated </summary> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.Logins"> <summary> Logins map used to authenticated with Amazon Cognito. Note: After modifying this field, you must manually call Clear on this instance of the CognitoAWSCredentials, as your Identity Id may have changed. </summary> </member> <member name="P:Amazon.CognitoIdentity.CognitoAWSCredentials.CurrentLoginProviders"> <summary> The list of current providers that are used for authenticated credentials. </summary> </member> <member name="E:Amazon.CognitoIdentity.CognitoAWSCredentials.IdentityChangedEvent"> <summary> Event for identity change notifications. This event will fire whenever the Identity Id changes. </summary> </member> <member name="T:Amazon.CognitoIdentity.CognitoAWSCredentials.IdentityChangedArgs"> <summary> Information about an identity change in the CognitoAWSCredentials. </summary> </member> <member name="T:Amazon.CognitoIdentity.CognitoAWSCredentials.GetIdentityIdStatus"> <summary> Simple class for returning back and identity id and whether the id returned was from a cache. </summary> </member> <member name="T:Amazon.CognitoIdentity.ErrorCode"> <summary> Constants used for properties of type ErrorCode. </summary> </member> <member name="F:Amazon.CognitoIdentity.ErrorCode.AccessDenied"> <summary> Constant AccessDenied for ErrorCode </summary> </member> <member name="F:Amazon.CognitoIdentity.ErrorCode.InternalServerError"> <summary> Constant InternalServerError for ErrorCode </summary> </member> <member name="M:Amazon.CognitoIdentity.ErrorCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CognitoIdentity.ErrorCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CognitoIdentity.AmazonCognitoIdentityRequest"> <summary> Base class for CognitoIdentity operation requests. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ConcurrentModificationException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.ConcurrentModificationException.#ctor(System.String)"> <summary> Constructs a new ConcurrentModificationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest"> <summary> Container for the parameters to the CreateIdentityPool operation. Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for <code>SupportedLoginProviders</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> You must use AWS Developer credentials to call this API. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest.AllowUnauthenticatedIdentities"> <summary> Gets and sets the property AllowUnauthenticatedIdentities. <para> TRUE if the identity pool supports unauthenticated logins. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>). </para> <para> Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. <para> A string that you provide. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest.OpenIdConnectProviderARNs"> <summary> Gets and sets the property OpenIdConnectProviderARNs. <para> A list of OpendID Connect provider ARNs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolRequest.SupportedLoginProviders"> <summary> Gets and sets the property SupportedLoginProviders. <para> Optional key:value pairs mapping provider names to provider app IDs. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse"> <summary> Configuration for accessing Amazon CreateIdentityPool service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult"> <summary> An object representing a Cognito identity pool. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.AllowUnauthenticatedIdentities"> <summary> Gets and sets the property AllowUnauthenticatedIdentities. TRUE if the identity pool supports unauthenticated logins. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. <para> A string that you provide. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.OpenIdConnectProviderARNs"> <summary> Gets and sets the property OpenIdConnectProviderARNs. <para> A list of OpendID Connect provider ARNs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResult.SupportedLoginProviders"> <summary> Gets and sets the property SupportedLoginProviders. <para> Optional key:value pairs mapping provider names to provider app IDs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.CreateIdentityPoolResponse.CreateIdentityPoolResult"> <summary> Gets and sets the CreateIdentityPoolResult property. Represents the output of a CreateIdentityPool operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Credentials"> <summary> Credentials for the provided identity ID. </summary> <summary> <para>AWS credentials for API authentication.</para> </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.Credentials.GetCredentials"> <summary> Returns a copy of ImmutableCredentials corresponding to these credentials </summary> <returns></returns> </member> <member name="P:Amazon.CognitoIdentity.Model.Credentials.AccessKeyId"> <summary> Gets and sets the property AccessKeyId. <para> The Access Key portion of the credentials. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.Credentials.Expiration"> <summary> Gets and sets the property Expiration. <para> The date at which these credentials will expire. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.Credentials.SecretKey"> <summary> Gets and sets the property SecretKey. <para> The Secret Access Key portion of the credentials </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.Credentials.SessionToken"> <summary> Gets and sets the property SessionToken. <para> The Session Token portion of the credentials </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest"> <summary> Container for the parameters to the DeleteIdentities operation. Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DeleteIdentitiesRequest.IdentityIdsToDelete"> <summary> Gets and sets the property IdentityIdsToDelete. <para> A list of 1-60 identities that you want to delete. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DeleteIdentitiesResponse"> <summary> Configuration for accessing Amazon DeleteIdentities service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DeleteIdentitiesResult"> <summary> Returned in response to a successful <code>DeleteIdentities</code> operation. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DeleteIdentitiesResult.UnprocessedIdentityIds"> <summary> Gets and sets the property UnprocessedIdentityIds. <para> An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DeleteIdentitiesResponse.DeleteIdentitiesResult"> <summary> Gets and sets the DeleteIdentitiesResult property. Represents the output of a DeleteIdentities operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest"> <summary> Container for the parameters to the DeleteIdentityPool operation. Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DeleteIdentityPoolRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest"> <summary> Container for the parameters to the DescribeIdentityPool operation. Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse"> <summary> Configuration for accessing Amazon DescribeIdentityPool service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult"> <summary> An object representing a Cognito identity pool. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.AllowUnauthenticatedIdentities"> <summary> Gets and sets the property AllowUnauthenticatedIdentities. TRUE if the identity pool supports unauthenticated logins. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. <para> A string that you provide. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.OpenIdConnectProviderARNs"> <summary> Gets and sets the property OpenIdConnectProviderARNs. <para> A list of OpendID Connect provider ARNs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResult.SupportedLoginProviders"> <summary> Gets and sets the property SupportedLoginProviders. <para> Optional key:value pairs mapping provider names to provider app IDs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityPoolResponse.DescribeIdentityPoolResult"> <summary> Gets and sets the DescribeIdentityPoolResult property. Represents the output of a DescribeIdentityPool operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityRequest"> <summary> Container for the parameters to the DescribeIdentity operation. Returns metadata related to the given identity, including when the identity was created and any associated linked logins. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityResponse"> <summary> Configuration for accessing Amazon DescribeIdentity service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DescribeIdentityResult"> <summary> A description of the identity. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityResult.CreationDate"> <summary> Gets and sets the property CreationDate. <para> Date on which the identity was created. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityResult.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityResult.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. <para> Date on which the identity was last modified. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityResult.Logins"> <summary> Gets and sets the property Logins. A set of optional name-value pairs that map provider names to provider tokens. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.DescribeIdentityResponse.DescribeIdentityResult"> <summary> Gets and sets the DescribeIdentityResult property. Represents the output of a DescribeIdentity operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.DeveloperUserAlreadyRegisteredException.#ctor(System.String)"> <summary> Constructs a new DeveloperUserAlreadyRegisteredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.ExternalServiceException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.ExternalServiceException.#ctor(System.String)"> <summary> Constructs a new ExternalServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest"> <summary> Container for the parameters to the GetCredentialsForIdentity operation. Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityRequest.Logins"> <summary> Gets and sets the property Logins. <para> A set of optional name-value pairs that map provider names to provider tokens. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResponse"> <summary> Configuration for accessing Amazon GetCredentialsForIdentity service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResult"> <summary> Returned in response to a successful <code>GetCredentialsForIdentity</code> operation. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResult.Credentials"> <summary> Gets and sets the property Credentials. <para> Credentials for the provided identity ID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResult.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetCredentialsForIdentityResponse.GetCredentialsForIdentityResult"> <summary> Gets and sets the GetCredentialsForIdentityResult property. Represents the output of a GetCredentialsForIdentity operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest"> <summary> Container for the parameters to the GetIdentityPoolRoles operation. Gets the roles for an identity pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse"> <summary> Configuration for accessing Amazon GetIdentityPoolRoles service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResult"> <summary> Returned in response to a successful <code>GetIdentityPoolRoles</code> operation. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResult.Roles"> <summary> Gets and sets the property Roles. <para> The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdentityPoolRolesResponse.GetIdentityPoolRolesResult"> <summary> Gets and sets the GetIdentityPoolRolesResult property. Represents the output of a GetIdentityPoolRoles operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdRequest"> <summary> Container for the parameters to the GetId operation. Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdRequest.AccountId"> <summary> Gets and sets the property AccountId. A standard AWS account ID (9+ digits). </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdRequest.Logins"> <summary> Gets and sets the property Logins. <para> A set of optional name-value pairs that map provider names to provider tokens. </para> <para> The available provider names for <code>Logins</code> are as follows: <ul> <li>Facebook: <code>graph.facebook.com</code> </li> <li>Google: <code>accounts.google.com</code> </li> <li>Amazon: <code>www.amazon.com</code> </li> <li>Twitter: <code>api.twitter.com</code> </li> <li>Digits: <code>www.digits.com</code> </li> </ul> </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdResponse"> <summary> Configuration for accessing Amazon GetId service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetIdResult"> <summary> Returned in response to a GetId request. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdResult.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetIdResponse.GetIdResult"> <summary> Gets and sets the GetIdResult property. Represents the output of a GetId operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest"> <summary> Container for the parameters to the GetOpenIdTokenForDeveloperIdentity operation. Registers (or retrieves) a Cognito <code>IdentityId</code> and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the <code>Logins</code> map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. <para> You can use <code>GetOpenIdTokenForDeveloperIdentity</code> to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the <code>IdentityId</code> should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing <code>IdentityId</code>. This API will create the identity in the specified <code>IdentityPoolId</code>. </para> <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest.Logins"> <summary> Gets and sets the property Logins. <para> A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax <code>"developer_provider_name": "developer_user_identifier"</code>. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest.TokenDuration"> <summary> Gets and sets the property TokenDuration. <para> The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResponse"> <summary> Configuration for accessing Amazon GetOpenIdTokenForDeveloperIdentity service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResult"> <summary> Returned in response to a successful <code>GetOpenIdTokenForDeveloperIdentity</code> request. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResult.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResult.Token"> <summary> Gets and sets the property Token. <para> An OpenID token. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityResponse.GetOpenIdTokenForDeveloperIdentityResult"> <summary> Gets and sets the GetOpenIdTokenForDeveloperIdentityResult property. Represents the output of a GetOpenIdTokenForDeveloperIdentity operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest"> <summary> Container for the parameters to the GetOpenIdToken operation. Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. <para> The OpenId token is valid for 15 minutes. </para> <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenRequest.Logins"> <summary> Gets and sets the property Logins. A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com or any other OpenId Connect provider, always include the id_token. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenResponse"> <summary> Configuration for accessing Amazon GetOpenIdToken service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.GetOpenIdTokenResult"> <summary> Returned in response to a successful GetOpenIdToken request. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenResult.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenResult.Token"> <summary> Gets and sets the property Token. An OpenID token, valid for 15 minutes. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.GetOpenIdTokenResponse.GetOpenIdTokenResult"> <summary> Gets and sets the GetOpenIdTokenResult property. Represents the output of a GetOpenIdToken operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.IdentityDescription"> <summary> A description of the identity. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityDescription.CreationDate"> <summary> Gets and sets the property CreationDate. <para> Date on which the identity was created. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityDescription.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityDescription.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. <para> Date on which the identity was last modified. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityDescription.Logins"> <summary> Gets and sets the property Logins. A set of optional name-value pairs that map provider names to provider tokens. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.IdentityPoolShortDescription"> <summary> A description of the identity pool. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityPoolShortDescription.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.IdentityPoolShortDescription.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. A string that you provide. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.InternalErrorException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.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.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.InvalidIdentityPoolConfigurationException.#ctor(System.String)"> <summary> Constructs a new InvalidIdentityPoolConfigurationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.InvalidParameterException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.InvalidParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.LimitExceededException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.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.CognitoIdentity.Model.ListIdentitiesRequest"> <summary> Container for the parameters to the ListIdentities operation. Lists the identities in a pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesRequest.HideDisabled"> <summary> Gets and sets the property HideDisabled. <para> An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of identities to return. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesRequest.NextToken"> <summary> Gets and sets the property NextToken. A pagination token. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ListIdentitiesResponse"> <summary> Configuration for accessing Amazon ListIdentities service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ListIdentitiesResult"> <summary> The response to a ListIdentities request. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesResult.Identities"> <summary> Gets and sets the property Identities. An object containing a set of identities and associated mappings. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesResult.NextToken"> <summary> Gets and sets the property NextToken. A pagination token. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentitiesResponse.ListIdentitiesResult"> <summary> Gets and sets the ListIdentitiesResult property. Represents the output of a ListIdentities operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest"> <summary> Container for the parameters to the ListIdentityPools operation. Lists all of the Cognito identity pools registered for your account. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of identities to return. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentityPoolsRequest.NextToken"> <summary> Gets and sets the property NextToken. A pagination token. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse"> <summary> Configuration for accessing Amazon ListIdentityPools service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.ListIdentityPoolsResult"> <summary> The result of a successful ListIdentityPools action. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentityPoolsResult.IdentityPools"> <summary> Gets and sets the property IdentityPools. The identity pools returned by the ListIdentityPools action. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentityPoolsResult.NextToken"> <summary> Gets and sets the property NextToken. A pagination token. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.ListIdentityPoolsResponse.ListIdentityPoolsResult"> <summary> Gets and sets the ListIdentityPoolsResult property. Represents the output of a ListIdentityPools operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest"> <summary> Container for the parameters to the LookupDeveloperIdentity operation. Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest.DeveloperUserIdentifier"> <summary> Gets and sets the property DeveloperUserIdentifier. <para> A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of identities to return. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A pagination token. The first call you make will have <code>NextToken</code> set to null. After that the service will return <code>NextToken</code> values as needed. For example, let's say you make a request with <code>MaxResults</code> set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResponse"> <summary> Configuration for accessing Amazon LookupDeveloperIdentity service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResult"> <summary> Returned in response to a successful <code>LookupDeveloperIdentity</code> action. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResult.DeveloperUserIdentifierList"> <summary> Gets and sets the property DeveloperUserIdentifierList. <para> This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResult.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A pagination token. The first call you make will have <code>NextToken</code> set to null. After that the service will return <code>NextToken</code> values as needed. For example, let's say you make a request with <code>MaxResults</code> set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.LookupDeveloperIdentityResponse.LookupDeveloperIdentityResult"> <summary> Gets and sets the LookupDeveloperIdentityResult property. Represents the output of a LookupDeveloperIdentity operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest"> <summary> Container for the parameters to the MergeDeveloperIdentities operation. Merges two users having different <code>IdentityId</code>s, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest.DestinationUserIdentifier"> <summary> Gets and sets the property DestinationUserIdentifier. <para> User identifier for the destination user. The value should be a <code>DeveloperUserIdentifier</code>. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (.), underscore (_), and dash (-). </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesRequest.SourceUserIdentifier"> <summary> Gets and sets the property SourceUserIdentifier. <para> User identifier for the source user. The value should be a <code>DeveloperUserIdentifier</code>. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResponse"> <summary> Configuration for accessing Amazon MergeDeveloperIdentities service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResult"> <summary> Returned in response to a successful <code>MergeDeveloperIdentities</code> action. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResult.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.MergeDeveloperIdentitiesResponse.MergeDeveloperIdentitiesResult"> <summary> Gets and sets the MergeDeveloperIdentitiesResult property. Represents the output of a MergeDeveloperIdentities operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.NotAuthorizedException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.NotAuthorizedException.#ctor(System.String)"> <summary> Constructs a new NotAuthorizedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.ResourceConflictException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.ResourceConflictException.#ctor(System.String)"> <summary> Constructs a new ResourceConflictException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.ResourceNotFoundException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.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.CognitoIdentity.Model.SetIdentityPoolRolesRequest"> <summary> Container for the parameters to the SetIdentityPoolRoles operation. Sets the roles for an identity pool. These roles are used when making calls to <code>GetCredentialsForIdentity</code> action. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.SetIdentityPoolRolesRequest.Roles"> <summary> Gets and sets the property Roles. <para> The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.TooManyRequestsException"> <summary> CognitoIdentity exception </summary> </member> <member name="M:Amazon.CognitoIdentity.Model.TooManyRequestsException.#ctor(System.String)"> <summary> Constructs a new TooManyRequestsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest"> <summary> Container for the parameters to the UnlinkDeveloperIdentity operation. Unlinks a <code>DeveloperUserIdentifier</code> from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest.DeveloperUserIdentifier"> <summary> Gets and sets the property DeveloperUserIdentifier. A unique ID used by your backend authentication process to identify a user. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkDeveloperIdentityRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> An identity pool ID in the format REGION:GUID. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.UnlinkIdentityRequest"> <summary> Container for the parameters to the UnlinkIdentity operation. Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible. <para> This is a public API. You do not need any credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkIdentityRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A unique identifier in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkIdentityRequest.Logins"> <summary> Gets and sets the property Logins. A set of optional name-value pairs that map provider names to provider tokens. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnlinkIdentityRequest.LoginsToRemove"> <summary> Gets and sets the property LoginsToRemove. Provider names to unlink from this identity. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.UnprocessedIdentityId"> <summary> An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnprocessedIdentityId.ErrorCode"> <summary> Gets and sets the property ErrorCode. <para> The error code indicating the type of error that occurred. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UnprocessedIdentityId.IdentityId"> <summary> Gets and sets the property IdentityId. <para> A unique identifier in the format REGION:GUID. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest"> <summary> Container for the parameters to the UpdateIdentityPool operation. Updates a user pool. <para> You must use AWS Developer credentials to call this API. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.AllowUnauthenticatedIdentities"> <summary> Gets and sets the property AllowUnauthenticatedIdentities. TRUE if the identity pool supports unauthenticated logins. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. <para> A string that you provide. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.OpenIdConnectProviderARNs"> <summary> Gets and sets the property OpenIdConnectProviderARNs. <para> A list of OpendID Connect provider ARNs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolRequest.SupportedLoginProviders"> <summary> Gets and sets the property SupportedLoginProviders. <para> Optional key:value pairs mapping provider names to provider app IDs. </para> </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse"> <summary> Configuration for accessing Amazon UpdateIdentityPool service </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult"> <summary> An object representing a Cognito identity pool. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.AllowUnauthenticatedIdentities"> <summary> Gets and sets the property AllowUnauthenticatedIdentities. TRUE if the identity pool supports unauthenticated logins. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.DeveloperProviderName"> <summary> Gets and sets the property DeveloperProviderName. <para> The "domain" by which Cognito will refer to your users. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. An identity pool ID in the format REGION:GUID. </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.IdentityPoolName"> <summary> Gets and sets the property IdentityPoolName. <para> A string that you provide. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.OpenIdConnectProviderARNs"> <summary> Gets and sets the property OpenIdConnectProviderARNs. <para> A list of OpendID Connect provider ARNs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResult.SupportedLoginProviders"> <summary> Gets and sets the property SupportedLoginProviders. <para> Optional key:value pairs mapping provider names to provider app IDs. </para> </summary> </member> <member name="P:Amazon.CognitoIdentity.Model.UpdateIdentityPoolResponse.UpdateIdentityPoolResult"> <summary> Gets and sets the UpdateIdentityPoolResult property. Represents the output of a UpdateIdentityPool operation. </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.CreateIdentityPoolRequestMarshaller"> <summary> CreateIdentityPool Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.CreateIdentityPoolResponseUnmarshaller"> <summary> Response Unmarshaller for CreateIdentityPool operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.CredentialsUnmarshaller"> <summary> Response Unmarshaller for Credentials Object </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DeleteIdentitiesRequestMarshaller"> <summary> DeleteIdentities Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DeleteIdentitiesResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteIdentities operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DeleteIdentityPoolRequestMarshaller"> <summary> DeleteIdentityPool Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DeleteIdentityPoolResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteIdentityPool operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DescribeIdentityPoolRequestMarshaller"> <summary> DescribeIdentityPool Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DescribeIdentityPoolResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIdentityPool operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DescribeIdentityRequestMarshaller"> <summary> DescribeIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.DescribeIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetCredentialsForIdentityRequestMarshaller"> <summary> GetCredentialsForIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetCredentialsForIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for GetCredentialsForIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetIdentityPoolRolesRequestMarshaller"> <summary> GetIdentityPoolRoles Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetIdentityPoolRolesResponseUnmarshaller"> <summary> Response Unmarshaller for GetIdentityPoolRoles operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetIdRequestMarshaller"> <summary> GetId Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetIdResponseUnmarshaller"> <summary> Response Unmarshaller for GetId operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetOpenIdTokenForDeveloperIdentityRequestMarshaller"> <summary> GetOpenIdTokenForDeveloperIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetOpenIdTokenForDeveloperIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for GetOpenIdTokenForDeveloperIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetOpenIdTokenRequestMarshaller"> <summary> GetOpenIdToken Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.GetOpenIdTokenResponseUnmarshaller"> <summary> Response Unmarshaller for GetOpenIdToken operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.IdentityDescriptionUnmarshaller"> <summary> Response Unmarshaller for IdentityDescription Object </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.IdentityPoolShortDescriptionUnmarshaller"> <summary> Response Unmarshaller for IdentityPoolShortDescription Object </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.ListIdentitiesRequestMarshaller"> <summary> ListIdentities Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.ListIdentitiesResponseUnmarshaller"> <summary> Response Unmarshaller for ListIdentities operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.ListIdentityPoolsRequestMarshaller"> <summary> ListIdentityPools Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.ListIdentityPoolsResponseUnmarshaller"> <summary> Response Unmarshaller for ListIdentityPools operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.LookupDeveloperIdentityRequestMarshaller"> <summary> LookupDeveloperIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.LookupDeveloperIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for LookupDeveloperIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.MergeDeveloperIdentitiesRequestMarshaller"> <summary> MergeDeveloperIdentities Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.MergeDeveloperIdentitiesResponseUnmarshaller"> <summary> Response Unmarshaller for MergeDeveloperIdentities operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.SetIdentityPoolRolesRequestMarshaller"> <summary> SetIdentityPoolRoles Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.SetIdentityPoolRolesResponseUnmarshaller"> <summary> Response Unmarshaller for SetIdentityPoolRoles operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UnlinkDeveloperIdentityRequestMarshaller"> <summary> UnlinkDeveloperIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UnlinkDeveloperIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for UnlinkDeveloperIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UnlinkIdentityRequestMarshaller"> <summary> UnlinkIdentity Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UnlinkIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for UnlinkIdentity operation </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UnprocessedIdentityIdUnmarshaller"> <summary> Response Unmarshaller for UnprocessedIdentityId Object </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UpdateIdentityPoolRequestMarshaller"> <summary> UpdateIdentityPool Request Marshaller </summary> </member> <member name="T:Amazon.CognitoIdentity.Model.Internal.MarshallTransformations.UpdateIdentityPoolResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateIdentityPool operation </summary> </member> <member name="T:Amazon.CognitoSync.AmazonCognitoSyncClient"> <summary> Implementation for accessing CognitoSync Amazon Cognito Sync <para> Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity. </para> <para> With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href="http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html">Amazon Cognito Identity service</a>. </para> <para> If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html">Developer Guide for Android</a> and the <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html">Developer Guide for iOS</a>. </para> </summary> </member> <member name="T:Amazon.CognitoSync.IAmazonCognitoSync"> <summary> Interface for accessing CognitoSync Amazon Cognito Sync <para> Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity. </para> <para> With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with <a href="http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/Welcome.html">Amazon Cognito Identity service</a>. </para> <para> If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-sync.html">Developer Guide for Android</a> and the <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-sync.html">Developer Guide for iOS</a>. </para> </summary> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest)"> <summary> Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish service method.</param> <returns>The response from the BulkPublish service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.AlreadyStreamedException"> An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully. </exception> <exception cref="T:Amazon.CognitoSync.Model.DuplicateRequestException"> An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginBulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BulkPublish operation. </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBulkPublish operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndBulkPublish(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BulkPublish operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBulkPublish.</param> <returns>Returns a BulkPublishResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest)"> <summary> Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset service method.</param> <returns>The response from the DeleteDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginDeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndDeleteDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDataset.</param> <returns>Returns a DeleteDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest)"> <summary> Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset service method.</param> <returns>The response from the DescribeDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginDescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndDescribeDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDataset.</param> <returns>Returns a DescribeDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityPoolUsage(System.String)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginDescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityPoolUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndDescribeIdentityPoolUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityPoolUsage.</param> <returns>Returns a DescribeIdentityPoolUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.DescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest)"> <summary> Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage service method.</param> <returns>The response from the DescribeIdentityUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginDescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndDescribeIdentityUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityUsage.</param> <returns>Returns a DescribeIdentityUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest)"> <summary> Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails service method.</param> <returns>The response from the GetBulkPublishDetails service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginGetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBulkPublishDetails operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndGetBulkPublishDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBulkPublishDetails.</param> <returns>Returns a GetBulkPublishDetailsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest)"> <summary> Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents service method.</param> <returns>The response from the GetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginGetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCognitoEvents operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndGetCognitoEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCognitoEvents.</param> <returns>Returns a GetCognitoEventsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetIdentityPoolConfiguration(System.String)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.GetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginGetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIdentityPoolConfiguration operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndGetIdentityPoolConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetIdentityPoolConfiguration.</param> <returns>Returns a GetIdentityPoolConfigurationResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest)"> <summary> Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets service method.</param> <returns>The response from the ListDatasets service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDatasets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasets operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndListDatasets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDatasets operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDatasets.</param> <returns>Returns a ListDatasetsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest)"> <summary> Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage service method.</param> <returns>The response from the ListIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentityPoolUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndListIdentityPoolUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentityPoolUsage.</param> <returns>Returns a ListIdentityPoolUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.ListRecords(Amazon.CognitoSync.Model.ListRecordsRequest)"> <summary> Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRecords service method.</param> <returns>The response from the ListRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginListRecords(Amazon.CognitoSync.Model.ListRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRecords operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndListRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRecords.</param> <returns>Returns a ListRecordsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.RegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest)"> <summary> Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice service method.</param> <returns>The response from the RegisterDevice service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginRegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterDevice operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndRegisterDevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterDevice operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterDevice.</param> <returns>Returns a RegisterDeviceResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest)"> <summary> Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents service method.</param> <returns>The response from the SetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginSetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetCognitoEvents operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndSetCognitoEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetCognitoEvents.</param> <returns>Returns a SetCognitoEventsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest)"> <summary> Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method.</param> <returns>The response from the SetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginSetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetIdentityPoolConfiguration operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndSetIdentityPoolConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetIdentityPoolConfiguration.</param> <returns>Returns a SetIdentityPoolConfigurationResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.SubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest)"> <summary> Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset service method.</param> <returns>The response from the SubscribeToDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginSubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSubscribeToDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndSubscribeToDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSubscribeToDataset.</param> <returns>Returns a SubscribeToDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest)"> <summary> Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset service method.</param> <returns>The response from the UnsubscribeFromDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginUnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnsubscribeFromDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndUnsubscribeFromDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnsubscribeFromDataset.</param> <returns>Returns a UnsubscribeFromDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.UpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest)"> <summary> Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para> <para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para> <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords service method.</param> <returns>The response from the UpdateRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException"> The AWS Lambda function returned invalid output or an exception. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.LambdaThrottledException"> AWS Lambda throttled your account, please contact AWS Support </exception> <exception cref="T:Amazon.CognitoSync.Model.LimitExceededException"> Thrown when the limit on the number of objects or operations has been exceeded. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.BeginUpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRecords operation.</returns> </member> <member name="M:Amazon.CognitoSync.IAmazonCognitoSync.EndUpdateRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRecords.</param> <returns>Returns a UpdateRecordsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Credentials and an AmazonCognitoSyncClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.#ctor(System.String,System.String,System.String,Amazon.CognitoSync.AmazonCognitoSyncConfig)"> <summary> Constructs AmazonCognitoSyncClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoSyncClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCognitoSyncClient Configuration Object</param> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest)"> <summary> Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish service method.</param> <returns>The response from the BulkPublish service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.AlreadyStreamedException"> An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully. </exception> <exception cref="T:Amazon.CognitoSync.Model.DuplicateRequestException"> An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginBulkPublish(Amazon.CognitoSync.Model.BulkPublishRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BulkPublish operation. </summary> <param name="request">Container for the necessary parameters to execute the BulkPublish operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBulkPublish operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndBulkPublish(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BulkPublish operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBulkPublish.</param> <returns>Returns a BulkPublishResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest)"> <summary> Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset service method.</param> <returns>The response from the DeleteDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginDeleteDataset(Amazon.CognitoSync.Model.DeleteDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndDeleteDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDataset.</param> <returns>Returns a DeleteDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest)"> <summary> Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset service method.</param> <returns>The response from the DescribeDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginDescribeDataset(Amazon.CognitoSync.Model.DescribeDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndDescribeDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDataset.</param> <returns>Returns a DescribeDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityPoolUsage(System.String)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest)"> <summary> Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage service method.</param> <returns>The response from the DescribeIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginDescribeIdentityPoolUsage(Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityPoolUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityPoolUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndDescribeIdentityPoolUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityPoolUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityPoolUsage.</param> <returns>Returns a DescribeIdentityPoolUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.DescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest)"> <summary> Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage service method.</param> <returns>The response from the DescribeIdentityUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginDescribeIdentityUsage(Amazon.CognitoSync.Model.DescribeIdentityUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIdentityUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeIdentityUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndDescribeIdentityUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIdentityUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIdentityUsage.</param> <returns>Returns a DescribeIdentityUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest)"> <summary> Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails service method.</param> <returns>The response from the GetBulkPublishDetails service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginGetBulkPublishDetails(Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="request">Container for the necessary parameters to execute the GetBulkPublishDetails operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetBulkPublishDetails operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndGetBulkPublishDetails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetBulkPublishDetails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetBulkPublishDetails.</param> <returns>Returns a GetBulkPublishDetailsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest)"> <summary> Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents service method.</param> <returns>The response from the GetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginGetCognitoEvents(Amazon.CognitoSync.Model.GetCognitoEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCognitoEvents operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCognitoEvents operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndGetCognitoEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCognitoEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetCognitoEvents.</param> <returns>Returns a GetCognitoEventsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetIdentityPoolConfiguration(System.String)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="identityPoolId">A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.GetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest)"> <summary> Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration service method.</param> <returns>The response from the GetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginGetIdentityPoolConfiguration(Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the GetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetIdentityPoolConfiguration operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndGetIdentityPoolConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetIdentityPoolConfiguration operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetIdentityPoolConfiguration.</param> <returns>Returns a GetIdentityPoolConfigurationResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest)"> <summary> Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets service method.</param> <returns>The response from the ListDatasets service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginListDatasets(Amazon.CognitoSync.Model.ListDatasetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDatasets operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDatasets operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDatasets operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndListDatasets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDatasets operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDatasets.</param> <returns>Returns a ListDatasetsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest)"> <summary> Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage service method.</param> <returns>The response from the ListIdentityPoolUsage service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginListIdentityPoolUsage(Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="request">Container for the necessary parameters to execute the ListIdentityPoolUsage operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListIdentityPoolUsage operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndListIdentityPoolUsage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListIdentityPoolUsage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListIdentityPoolUsage.</param> <returns>Returns a ListIdentityPoolUsageResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.ListRecords(Amazon.CognitoSync.Model.ListRecordsRequest)"> <summary> Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListRecords service method.</param> <returns>The response from the ListRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginListRecords(Amazon.CognitoSync.Model.ListRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRecords operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRecords operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndListRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRecords.</param> <returns>Returns a ListRecordsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.RegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest)"> <summary> Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice service method.</param> <returns>The response from the RegisterDevice service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginRegisterDevice(Amazon.CognitoSync.Model.RegisterDeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterDevice operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterDevice operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndRegisterDevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterDevice operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterDevice.</param> <returns>Returns a RegisterDeviceResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest)"> <summary> Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents service method.</param> <returns>The response from the SetCognitoEvents service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginSetCognitoEvents(Amazon.CognitoSync.Model.SetCognitoEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the SetCognitoEvents operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetCognitoEvents operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndSetCognitoEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetCognitoEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetCognitoEvents.</param> <returns>Returns a SetCognitoEventsResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest)"> <summary> Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration service method.</param> <returns>The response from the SetIdentityPoolConfiguration service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.ConcurrentModificationException"> Thrown if there are parallel requests to modify a resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginSetIdentityPoolConfiguration(Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="request">Container for the necessary parameters to execute the SetIdentityPoolConfiguration operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetIdentityPoolConfiguration operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndSetIdentityPoolConfiguration(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetIdentityPoolConfiguration operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetIdentityPoolConfiguration.</param> <returns>Returns a SetIdentityPoolConfigurationResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.SubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest)"> <summary> Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset service method.</param> <returns>The response from the SubscribeToDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginSubscribeToDataset(Amazon.CognitoSync.Model.SubscribeToDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the SubscribeToDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSubscribeToDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndSubscribeToDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SubscribeToDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSubscribeToDataset.</param> <returns>Returns a SubscribeToDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest)"> <summary> Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset service method.</param> <returns>The response from the UnsubscribeFromDataset service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidConfigurationException"> </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginUnsubscribeFromDataset(Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="request">Container for the necessary parameters to execute the UnsubscribeFromDataset operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnsubscribeFromDataset operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndUnsubscribeFromDataset(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnsubscribeFromDataset operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnsubscribeFromDataset.</param> <returns>Returns a UnsubscribeFromDatasetResult from CognitoSync.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.UpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest)"> <summary> Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para> <para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para> <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords service method.</param> <returns>The response from the UpdateRecords service method, as returned by CognitoSync.</returns> <exception cref="T:Amazon.CognitoSync.Model.InternalErrorException"> Indicates an internal service error. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException"> The AWS Lambda function returned invalid output or an exception. </exception> <exception cref="T:Amazon.CognitoSync.Model.InvalidParameterException"> Thrown when a request parameter does not comply with the associated constraints. </exception> <exception cref="T:Amazon.CognitoSync.Model.LambdaThrottledException"> AWS Lambda throttled your account, please contact AWS Support </exception> <exception cref="T:Amazon.CognitoSync.Model.LimitExceededException"> Thrown when the limit on the number of objects or operations has been exceeded. </exception> <exception cref="T:Amazon.CognitoSync.Model.NotAuthorizedException"> Thrown when a user is not authorized to access the requested resource. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceConflictException"> Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict. </exception> <exception cref="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> Thrown if the resource doesn't exist. </exception> <exception cref="T:Amazon.CognitoSync.Model.TooManyRequestsException"> Thrown if the request is throttled. </exception> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.BeginUpdateRecords(Amazon.CognitoSync.Model.UpdateRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRecords operation on AmazonCognitoSyncClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRecords operation.</returns> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncClient.EndUpdateRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRecords.</param> <returns>Returns a UpdateRecordsResult from CognitoSync.</returns> </member> <member name="T:Amazon.CognitoSync.AmazonCognitoSyncConfig"> <summary> Configuration for accessing Amazon CognitoSync service </summary> </member> <member name="M:Amazon.CognitoSync.AmazonCognitoSyncConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CognitoSync.AmazonCognitoSyncConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CognitoSync.AmazonCognitoSyncConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CognitoSync.BulkPublishStatus"> <summary> Constants used for properties of type BulkPublishStatus. </summary> </member> <member name="F:Amazon.CognitoSync.BulkPublishStatus.FAILED"> <summary> Constant FAILED for BulkPublishStatus </summary> </member> <member name="F:Amazon.CognitoSync.BulkPublishStatus.IN_PROGRESS"> <summary> Constant IN_PROGRESS for BulkPublishStatus </summary> </member> <member name="F:Amazon.CognitoSync.BulkPublishStatus.NOT_STARTED"> <summary> Constant NOT_STARTED for BulkPublishStatus </summary> </member> <member name="F:Amazon.CognitoSync.BulkPublishStatus.SUCCEEDED"> <summary> Constant SUCCEEDED for BulkPublishStatus </summary> </member> <member name="M:Amazon.CognitoSync.BulkPublishStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CognitoSync.BulkPublishStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CognitoSync.Operation"> <summary> Constants used for properties of type Operation. </summary> </member> <member name="F:Amazon.CognitoSync.Operation.Remove"> <summary> Constant Remove for Operation </summary> </member> <member name="F:Amazon.CognitoSync.Operation.Replace"> <summary> Constant Replace for Operation </summary> </member> <member name="M:Amazon.CognitoSync.Operation.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CognitoSync.Operation.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CognitoSync.Platform"> <summary> Constants used for properties of type Platform. </summary> </member> <member name="F:Amazon.CognitoSync.Platform.ADM"> <summary> Constant ADM for Platform </summary> </member> <member name="F:Amazon.CognitoSync.Platform.APNS"> <summary> Constant APNS for Platform </summary> </member> <member name="F:Amazon.CognitoSync.Platform.APNS_SANDBOX"> <summary> Constant APNS_SANDBOX for Platform </summary> </member> <member name="F:Amazon.CognitoSync.Platform.GCM"> <summary> Constant GCM for Platform </summary> </member> <member name="M:Amazon.CognitoSync.Platform.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CognitoSync.Platform.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CognitoSync.StreamingStatus"> <summary> Constants used for properties of type StreamingStatus. </summary> </member> <member name="F:Amazon.CognitoSync.StreamingStatus.DISABLED"> <summary> Constant DISABLED for StreamingStatus </summary> </member> <member name="F:Amazon.CognitoSync.StreamingStatus.ENABLED"> <summary> Constant ENABLED for StreamingStatus </summary> </member> <member name="M:Amazon.CognitoSync.StreamingStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CognitoSync.StreamingStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CognitoSync.Internal.CognitoCredentialsRetriever"> <summary> This handler overrides the base CredentialsRetriever which is removed from the pipeline. When the service client is using the CognitoAWSCredentials credentials object it makes sure that all CognitoSync calls have the latest identity id and identity pool id. </summary> </member> <member name="T:Amazon.Runtime.Internal.CredentialsRetriever"> <summary> This handler retrieved the AWS credentials to be used for the current call. </summary> </member> <member name="T:Amazon.Runtime.Internal.PipelineHandler"> <summary> An abstract pipeline handler that has implements IPipelineHandler, and has the default implmentation. This is the base class for most of the handler implementations. </summary> </member> <member name="T:Amazon.Runtime.IPipelineHandler"> <summary> Interface for a handler in a pipeline. </summary> </member> <member name="M:Amazon.Runtime.IPipelineHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Contains the processing logic for a synchronous request invocation. This method should call InnerHandler.InvokeSync to continue processing of the request by the pipeline, unless it's a terminating handler. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.Runtime.IPipelineHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Contains the processing logic for an asynchronous request invocation. This method should call InnerHandler.InvokeSync to continue processing of the request by the pipeline, unless it's a terminating handler. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent a async operation.</returns> </member> <member name="M:Amazon.Runtime.IPipelineHandler.AsyncCallback(Amazon.Runtime.IAsyncExecutionContext)"> <summary> This callback method contains the processing logic that should be executed after the underlying asynchronous operation completes. This method is called as part of a callback chain which starts from the InvokeAsyncCallback method of the bottommost handler and then invokes each callback method of the handler above it. This method should call OuterHandler.AsyncCallback to continue processing of the request by the pipeline, unless it's the topmost handler. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="P:Amazon.Runtime.IPipelineHandler.Logger"> <summary> The logger used to log messages. </summary> </member> <member name="P:Amazon.Runtime.IPipelineHandler.InnerHandler"> <summary> The inner handler which is called after the current handler completes it's processing. </summary> </member> <member name="P:Amazon.Runtime.IPipelineHandler.OuterHandler"> <summary> The outer handler which encapsulates the current handler. </summary> </member> <member name="M:Amazon.Runtime.Internal.PipelineHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Contains the processing logic for a synchronous request invocation. This method calls InnerHandler.InvokeSync to continue processing of the request by the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.Runtime.Internal.PipelineHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Contains the processing logic for an asynchronous request invocation. This method should calls InnerHandler.InvokeSync to continue processing of the request by the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="M:Amazon.Runtime.Internal.PipelineHandler.AsyncCallback(Amazon.Runtime.IAsyncExecutionContext)"> <summary> This callback method is called by the callback method of the inner handler as part of asynchronous processing after any underlying asynchronous operations complete. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="M:Amazon.Runtime.Internal.PipelineHandler.InvokeAsyncCallback(Amazon.Runtime.IAsyncExecutionContext)"> <summary> This callback method contains the processing logic that should be executed after the underlying asynchronous operation completes. This method is called as part of a callback chain which starts from the InvokeAsyncCallback method of the bottommost handler and then invokes each callback method of the handler above it. This method calls OuterHandler.AsyncCallback to continue processing of the request by the pipeline, unless it's the topmost handler. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="M:Amazon.Runtime.Internal.PipelineHandler.LogMetrics(Amazon.Runtime.IExecutionContext)"> <summary> Logs the metrics for the current execution context. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="P:Amazon.Runtime.Internal.PipelineHandler.Logger"> <summary> The logger used to log messages. </summary> </member> <member name="P:Amazon.Runtime.Internal.PipelineHandler.InnerHandler"> <summary> The inner handler which is called after the current handler completes it's processing. </summary> </member> <member name="P:Amazon.Runtime.Internal.PipelineHandler.OuterHandler"> <summary> The outer handler which encapsulates the current handler. </summary> </member> <member name="M:Amazon.Runtime.Internal.CredentialsRetriever.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> The constructor for CredentialsRetriever. </summary> <param name="credentials">An AWSCredentials instance.</param> </member> <member name="M:Amazon.Runtime.Internal.CredentialsRetriever.PreInvoke(Amazon.Runtime.IExecutionContext)"> <summary> Retrieves the credentials to be used for the current call before invoking the next handler. </summary> <param name="executionContext"></param> </member> <member name="M:Amazon.Runtime.Internal.CredentialsRetriever.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.Runtime.Internal.CredentialsRetriever.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="T:Amazon.CognitoSync.Internal.CognitoCredentialsRetriever.CSRequestCache"> <summary> A cache of objects that store the reflection objects. This is done so that reflection is only used once in order to set the fields on the request. </summary> </member> <member name="M:Amazon.CognitoSync.Internal.CognitoCredentialsRetriever.CSRequestCache.SetFields(Amazon.CognitoSync.AmazonCognitoSyncRequest,System.String,System.String)"> <summary> Set the IdentityId and IdentityPoolId properties on the request object </summary> <param name="request"></param> <param name="identityPoolId"></param> <param name="identityId"></param> </member> <member name="T:Amazon.CognitoSync.Internal.CognitoCredentialsRetriever.CSRequestCache.CSRequest"> <summary> This class holds on to the reflection objects to invoke the setters for IdentityId and IdentityPoolId for the given type. </summary> </member> <member name="T:Amazon.CognitoSync.Model.AlreadyStreamedException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.AlreadyStreamedException.#ctor(System.String)"> <summary> Constructs a new AlreadyStreamedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.AmazonCognitoSyncRequest"> <summary> Base class for CognitoSync operation requests. </summary> </member> <member name="T:Amazon.CognitoSync.Model.BulkPublishRequest"> <summary> Container for the parameters to the BulkPublish operation. Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.BulkPublishRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.BulkPublishResponse"> <summary> Configuration for accessing Amazon BulkPublish service </summary> </member> <member name="T:Amazon.CognitoSync.Model.BulkPublishResult"> <summary> The output for the BulkPublish operation. </summary> </member> <member name="P:Amazon.CognitoSync.Model.BulkPublishResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.BulkPublishResponse.BulkPublishResult"> <summary> Gets and sets the BulkPublishResult property. Represents the output of a BulkPublish operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.CognitoStreams"> <summary> Configuration options for configure Cognito streams. </summary> </member> <member name="P:Amazon.CognitoSync.Model.CognitoStreams.RoleArn"> <summary> Gets and sets the property RoleArn. The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream. </summary> </member> <member name="P:Amazon.CognitoSync.Model.CognitoStreams.StreamingStatus"> <summary> Gets and sets the property StreamingStatus. Status of the Cognito streams. Valid values are: <para> ENABLED - Streaming of updates to identity pool is enabled. </para> <para> DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.CognitoStreams.StreamName"> <summary> Gets and sets the property StreamName. The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ConcurrentModificationException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.ConcurrentModificationException.#ctor(System.String)"> <summary> Constructs a new ConcurrentModificationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.Dataset"> <summary> A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.CreationDate"> <summary> Gets and sets the property CreationDate. Date on which the dataset was created. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.DatasetName"> <summary> Gets and sets the property DatasetName. A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.DataStorage"> <summary> Gets and sets the property DataStorage. Total size in bytes of the records in this dataset. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.LastModifiedBy"> <summary> Gets and sets the property LastModifiedBy. The device that made the last change to this dataset. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. Date when the dataset was last modified. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Dataset.NumRecords"> <summary> Gets and sets the property NumRecords. Number of records in this dataset. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DeleteDatasetRequest"> <summary> Container for the parameters to the DeleteDataset operation. Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.DeleteDatasetRequest.DatasetName"> <summary> Gets and sets the property DatasetName. A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </summary> </member> <member name="P:Amazon.CognitoSync.Model.DeleteDatasetRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DeleteDatasetRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DeleteDatasetResponse"> <summary> Configuration for accessing Amazon DeleteDataset service </summary> </member> <member name="T:Amazon.CognitoSync.Model.DeleteDatasetResult"> <summary> Response to a successful DeleteDataset request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DeleteDatasetResult.Dataset"> <summary> Gets and sets the property Dataset. A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DeleteDatasetResponse.DeleteDatasetResult"> <summary> Gets and sets the DeleteDatasetResult property. Represents the output of a DeleteDataset operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeDatasetRequest"> <summary> Container for the parameters to the DescribeDataset operation. Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeDatasetRequest.DatasetName"> <summary> Gets and sets the property DatasetName. A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeDatasetRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeDatasetRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeDatasetResponse"> <summary> Configuration for accessing Amazon DescribeDataset service </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeDatasetResult"> <summary> Response to a successful DescribeDataset request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeDatasetResult.Dataset"> <summary> Gets and sets the property Dataset. Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeDatasetResponse.DescribeDatasetResult"> <summary> Gets and sets the DescribeDatasetResult property. Represents the output of a DescribeDataset operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest"> <summary> Container for the parameters to the DescribeIdentityPoolUsage operation. Gets usage details (for example, data storage) about a particular identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResponse"> <summary> Configuration for accessing Amazon DescribeIdentityPoolUsage service </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResult"> <summary> Response to a successful DescribeIdentityPoolUsage request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResult.IdentityPoolUsage"> <summary> Gets and sets the property IdentityPoolUsage. Information about the usage of the identity pool. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityPoolUsageResponse.DescribeIdentityPoolUsageResult"> <summary> Gets and sets the DescribeIdentityPoolUsageResult property. Represents the output of a DescribeIdentityPoolUsage operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityUsageRequest"> <summary> Container for the parameters to the DescribeIdentityUsage operation. Gets usage information for an identity, including number of datasets and data usage. <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityUsageRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityUsageRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityUsageResponse"> <summary> Configuration for accessing Amazon DescribeIdentityUsage service </summary> </member> <member name="T:Amazon.CognitoSync.Model.DescribeIdentityUsageResult"> <summary> The response to a successful DescribeIdentityUsage request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityUsageResult.IdentityUsage"> <summary> Gets and sets the property IdentityUsage. Usage information for the identity. </summary> </member> <member name="P:Amazon.CognitoSync.Model.DescribeIdentityUsageResponse.DescribeIdentityUsageResult"> <summary> Gets and sets the DescribeIdentityUsageResult property. Represents the output of a DescribeIdentityUsage operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.DuplicateRequestException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.DuplicateRequestException.#ctor(System.String)"> <summary> Constructs a new DuplicateRequestException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest"> <summary> Container for the parameters to the GetBulkPublishDetails operation. Get the status of the last BulkPublish operation for an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetBulkPublishDetailsResponse"> <summary> Configuration for accessing Amazon GetBulkPublishDetails service </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult"> <summary> The output for the GetBulkPublishDetails operation. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult.BulkPublishCompleteTime"> <summary> Gets and sets the property BulkPublishCompleteTime. If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult.BulkPublishStartTime"> <summary> Gets and sets the property BulkPublishStartTime. The date/time at which the last bulk publish was initiated. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult.BulkPublishStatus"> <summary> Gets and sets the property BulkPublishStatus. Status of the last bulk publish operation, valid values are: <para> NOT_STARTED - No bulk publish has been requested for this identity pool </para> <para> IN_PROGRESS - Data is being published to the configured stream </para> <para> SUCCEEDED - All data for the identity pool has been published to the configured stream </para> <para> FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult.FailureMessage"> <summary> Gets and sets the property FailureMessage. If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetBulkPublishDetailsResponse.GetBulkPublishDetailsResult"> <summary> Gets and sets the GetBulkPublishDetailsResult property. Represents the output of a GetBulkPublishDetails operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetCognitoEventsRequest"> <summary> Container for the parameters to the GetCognitoEvents operation. Gets the events and the corresponding Lambda functions associated with an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetCognitoEventsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> The Cognito Identity Pool ID for the request </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetCognitoEventsResponse"> <summary> Configuration for accessing Amazon GetCognitoEvents service </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetCognitoEventsResult"> <summary> The response from the GetCognitoEvents request </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetCognitoEventsResult.Events"> <summary> Gets and sets the property Events. <para> The Cognito Events returned from the GetCognitoEvents request </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetCognitoEventsResponse.GetCognitoEventsResult"> <summary> Gets and sets the GetCognitoEventsResult property. Represents the output of a GetCognitoEvents operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest"> <summary> Container for the parameters to the GetIdentityPoolConfiguration operation. Gets the configuration settings of an identity pool. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResponse"> <summary> Configuration for accessing Amazon GetIdentityPoolConfiguration service </summary> </member> <member name="T:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResult"> <summary> The output for the GetIdentityPoolConfiguration operation. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResult.CognitoStreams"> <summary> Gets and sets the property CognitoStreams. Options to apply to this identity pool for Amazon Cognito streams. </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResult.PushSync"> <summary> Gets and sets the property PushSync. <para> Options to apply to this identity pool for push synchronization. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.GetIdentityPoolConfigurationResponse.GetIdentityPoolConfigurationResult"> <summary> Gets and sets the GetIdentityPoolConfigurationResult property. Represents the output of a GetIdentityPoolConfiguration operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.IdentityPoolUsage"> <summary> Usage information for the identity pool. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityPoolUsage.DataStorage"> <summary> Gets and sets the property DataStorage. Data storage information for the identity pool. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityPoolUsage.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityPoolUsage.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. Date on which the identity pool was last modified. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityPoolUsage.SyncSessionsCount"> <summary> Gets and sets the property SyncSessionsCount. Number of sync sessions for the identity pool. </summary> </member> <member name="T:Amazon.CognitoSync.Model.IdentityUsage"> <summary> Usage information for the identity. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityUsage.DatasetCount"> <summary> Gets and sets the property DatasetCount. Number of datasets for the identity. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityUsage.DataStorage"> <summary> Gets and sets the property DataStorage. Total data storage for this identity. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityUsage.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityUsage.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.IdentityUsage.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. Date on which the identity was last modified. </summary> </member> <member name="T:Amazon.CognitoSync.Model.InternalErrorException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.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.CognitoSync.Model.InvalidConfigurationException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.InvalidConfigurationException.#ctor(System.String)"> <summary> Constructs a new InvalidConfigurationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.InvalidLambdaFunctionOutputException.#ctor(System.String)"> <summary> Constructs a new InvalidLambdaFunctionOutputException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.InvalidParameterException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.InvalidParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.KinesisStreaming"> <summary> </summary> </member> <member name="P:Amazon.CognitoSync.Model.KinesisStreaming.KinesisRoleArn"> <summary> Gets and sets the property KinesisRoleArn. </summary> </member> <member name="P:Amazon.CognitoSync.Model.KinesisStreaming.StreamingStatus"> <summary> Gets and sets the property StreamingStatus. </summary> </member> <member name="P:Amazon.CognitoSync.Model.KinesisStreaming.StreamName"> <summary> Gets and sets the property StreamName. </summary> </member> <member name="T:Amazon.CognitoSync.Model.LambdaThrottledException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.LambdaThrottledException.#ctor(System.String)"> <summary> Constructs a new LambdaThrottledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.LimitExceededException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.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.CognitoSync.Model.ListDatasetsRequest"> <summary> Container for the parameters to the ListDatasets operation. Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of results to be returned. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsRequest.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListDatasetsResponse"> <summary> Configuration for accessing Amazon ListDatasets service </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListDatasetsResult"> <summary> Returned for a successful ListDatasets request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsResult.Count"> <summary> Gets and sets the property Count. Number of datasets returned. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsResult.Datasets"> <summary> Gets and sets the property Datasets. A set of datasets. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsResult.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListDatasetsResponse.ListDatasetsResult"> <summary> Gets and sets the ListDatasetsResult property. Represents the output of a ListDatasets operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest"> <summary> Container for the parameters to the ListIdentityPoolUsage operation. Gets a list of identity pools registered with Cognito. <para> ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of results to be returned. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageRequest.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListIdentityPoolUsageResponse"> <summary> Configuration for accessing Amazon ListIdentityPoolUsage service </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListIdentityPoolUsageResult"> <summary> Returned for a successful ListIdentityPoolUsage request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageResult.Count"> <summary> Gets and sets the property Count. Total number of identities for the identity pool. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageResult.IdentityPoolUsages"> <summary> Gets and sets the property IdentityPoolUsages. Usage information for the identity pools. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageResult.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of results to be returned. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageResult.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListIdentityPoolUsageResponse.ListIdentityPoolUsageResult"> <summary> Gets and sets the ListIdentityPoolUsageResult property. Represents the output of a ListIdentityPoolUsage operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListRecordsRequest"> <summary> Container for the parameters to the ListRecords operation. Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data. <para> ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.DatasetName"> <summary> Gets and sets the property DatasetName. A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.LastSyncCount"> <summary> Gets and sets the property LastSyncCount. The last server sync count for this record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. The maximum number of results to be returned. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsRequest.SyncSessionToken"> <summary> Gets and sets the property SyncSessionToken. A token containing a session ID, identity ID, and expiration. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListRecordsResponse"> <summary> Configuration for accessing Amazon ListRecords service </summary> </member> <member name="T:Amazon.CognitoSync.Model.ListRecordsResult"> <summary> Returned for a successful ListRecordsRequest. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.Count"> <summary> Gets and sets the property Count. Total number of records. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.DatasetDeletedAfterRequestedSyncCount"> <summary> Gets and sets the property DatasetDeletedAfterRequestedSyncCount. A boolean value specifying whether to delete the dataset locally. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.DatasetExists"> <summary> Gets and sets the property DatasetExists. Indicates whether the dataset exists. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.DatasetSyncCount"> <summary> Gets and sets the property DatasetSyncCount. Server sync count for this dataset. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.LastModifiedBy"> <summary> Gets and sets the property LastModifiedBy. The user/device that made the last change to this record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.MergedDatasetNames"> <summary> Gets and sets the property MergedDatasetNames. Names of merged datasets. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.NextToken"> <summary> Gets and sets the property NextToken. A pagination token for obtaining the next page of results. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.Records"> <summary> Gets and sets the property Records. A list of all records. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResult.SyncSessionToken"> <summary> Gets and sets the property SyncSessionToken. A token containing a session ID, identity ID, and expiration. </summary> </member> <member name="P:Amazon.CognitoSync.Model.ListRecordsResponse.ListRecordsResult"> <summary> Gets and sets the ListRecordsResult property. Represents the output of a ListRecords operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.NotAuthorizedException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.NotAuthorizedException.#ctor(System.String)"> <summary> Constructs a new NotAuthorizedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.PushSync"> <summary> Configuration options to be applied to the identity pool. </summary> </member> <member name="P:Amazon.CognitoSync.Model.PushSync.ApplicationArns"> <summary> Gets and sets the property ApplicationArns. <para> List of SNS platform application ARNs that could be used by clients. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.PushSync.RoleArn"> <summary> Gets and sets the property RoleArn. <para> A role configured to allow Cognito to call SNS on behalf of the developer. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.Record"> <summary> The basic data structure of a dataset. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.DeviceLastModifiedDate"> <summary> Gets and sets the property DeviceLastModifiedDate. The last modified date of the client device. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.Key"> <summary> Gets and sets the property Key. The key for the record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.LastModifiedBy"> <summary> Gets and sets the property LastModifiedBy. The user/device that made the last change to this record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.LastModifiedDate"> <summary> Gets and sets the property LastModifiedDate. The date on which the record was last modified. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.SyncCount"> <summary> Gets and sets the property SyncCount. The server sync count for this record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.Record.Value"> <summary> Gets and sets the property Value. The value for the record. </summary> </member> <member name="T:Amazon.CognitoSync.Model.RecordPatch"> <summary> An update operation for a record. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RecordPatch.DeviceLastModifiedDate"> <summary> Gets and sets the property DeviceLastModifiedDate. The last modified date of the client device. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RecordPatch.Key"> <summary> Gets and sets the property Key. The key associated with the record patch. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RecordPatch.Op"> <summary> Gets and sets the property Op. An operation, either replace or remove. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RecordPatch.SyncCount"> <summary> Gets and sets the property SyncCount. Last known server sync count for this record. Set to 0 if unknown. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RecordPatch.Value"> <summary> Gets and sets the property Value. The value associated with the record patch. </summary> </member> <member name="T:Amazon.CognitoSync.Model.RegisterDeviceRequest"> <summary> Container for the parameters to the RegisterDevice operation. Registers a device to receive push sync notifications. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> The unique ID for this identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceRequest.Platform"> <summary> Gets and sets the property Platform. <para> The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX). </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceRequest.Token"> <summary> Gets and sets the property Token. <para> The push token. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.RegisterDeviceResponse"> <summary> Configuration for accessing Amazon RegisterDevice service </summary> </member> <member name="T:Amazon.CognitoSync.Model.RegisterDeviceResult"> <summary> Response to a RegisterDevice request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceResult.DeviceId"> <summary> Gets and sets the property DeviceId. <para> The unique ID generated for this device by Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.RegisterDeviceResponse.RegisterDeviceResult"> <summary> Gets and sets the RegisterDeviceResult property. Represents the output of a RegisterDevice operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.ResourceConflictException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.ResourceConflictException.#ctor(System.String)"> <summary> Constructs a new ResourceConflictException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.ResourceNotFoundException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.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.CognitoSync.Model.SetCognitoEventsRequest"> <summary> Container for the parameters to the SetCognitoEvents operation. Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetCognitoEventsRequest.Events"> <summary> Gets and sets the property Events. <para> The events to configure </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetCognitoEventsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> The Cognito Identity Pool to use when configuring Cognito Events </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest"> <summary> Container for the parameters to the SetIdentityPoolConfiguration operation. Sets the necessary configuration for push sync. <para> This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest.CognitoStreams"> <summary> Gets and sets the property CognitoStreams. Options to apply to this identity pool for Amazon Cognito streams. </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationRequest.PushSync"> <summary> Gets and sets the property PushSync. <para> Options to apply to this identity pool for push synchronization. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResponse"> <summary> Configuration for accessing Amazon SetIdentityPoolConfiguration service </summary> </member> <member name="T:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResult"> <summary> The output for the SetIdentityPoolConfiguration operation </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResult.CognitoStreams"> <summary> Gets and sets the property CognitoStreams. Options to apply to this identity pool for Amazon Cognito streams. </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResult.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResult.PushSync"> <summary> Gets and sets the property PushSync. <para> Options to apply to this identity pool for push synchronization. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SetIdentityPoolConfigurationResponse.SetIdentityPoolConfigurationResult"> <summary> Gets and sets the SetIdentityPoolConfigurationResult property. Represents the output of a SetIdentityPoolConfiguration operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.SubscribeToDatasetRequest"> <summary> Container for the parameters to the SubscribeToDataset operation. Subscribes to receive notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SubscribeToDatasetRequest.DatasetName"> <summary> Gets and sets the property DatasetName. <para> The name of the dataset to subcribe to. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SubscribeToDatasetRequest.DeviceId"> <summary> Gets and sets the property DeviceId. <para> The unique ID generated for this device by Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SubscribeToDatasetRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> Unique ID for this identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.SubscribeToDatasetRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.SubscribeToDatasetResponse"> <summary> Configuration for accessing Amazon SubscribeToDataset service </summary> </member> <member name="T:Amazon.CognitoSync.Model.SubscribeToDatasetResult"> <summary> Response to a SubscribeToDataset request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.SubscribeToDatasetResponse.SubscribeToDatasetResult"> <summary> Gets and sets the SubscribeToDatasetResult property. Represents the output of a SubscribeToDataset operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.TooManyRequestsException"> <summary> CognitoSync exception </summary> </member> <member name="M:Amazon.CognitoSync.Model.TooManyRequestsException.#ctor(System.String)"> <summary> Constructs a new TooManyRequestsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest"> <summary> Container for the parameters to the UnsubscribeFromDataset operation. Unsubscribes from receiving notifications when a dataset is modified by another device. <para> This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest.DatasetName"> <summary> Gets and sets the property DatasetName. <para> The name of the dataset from which to unsubcribe. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest.DeviceId"> <summary> Gets and sets the property DeviceId. <para> The unique ID generated for this device by Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest.IdentityId"> <summary> Gets and sets the property IdentityId. <para> Unique ID for this identity. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UnsubscribeFromDatasetRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. <para> A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs. </para> </summary> </member> <member name="T:Amazon.CognitoSync.Model.UnsubscribeFromDatasetResponse"> <summary> Configuration for accessing Amazon UnsubscribeFromDataset service </summary> </member> <member name="T:Amazon.CognitoSync.Model.UnsubscribeFromDatasetResult"> <summary> Response to an UnsubscribeFromDataset request. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UnsubscribeFromDatasetResponse.UnsubscribeFromDatasetResult"> <summary> Gets and sets the UnsubscribeFromDatasetResult property. Represents the output of a UnsubscribeFromDataset operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.UpdateRecordsRequest"> <summary> Container for the parameters to the UpdateRecords operation. Posts updates to records and adds and deletes records for a dataset and user. <para> The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count. </para> <para> For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0. </para> <para> This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.ClientContext"> <summary> Gets and sets the property ClientContext. Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.DatasetName"> <summary> Gets and sets the property DatasetName. A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot). </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.DeviceId"> <summary> Gets and sets the property DeviceId. <para> The unique ID generated for this device by Cognito. </para> </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.IdentityId"> <summary> Gets and sets the property IdentityId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.IdentityPoolId"> <summary> Gets and sets the property IdentityPoolId. A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.RecordPatches"> <summary> Gets and sets the property RecordPatches. A list of patch operations. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsRequest.SyncSessionToken"> <summary> Gets and sets the property SyncSessionToken. The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity. </summary> </member> <member name="T:Amazon.CognitoSync.Model.UpdateRecordsResponse"> <summary> Configuration for accessing Amazon UpdateRecords service </summary> </member> <member name="T:Amazon.CognitoSync.Model.UpdateRecordsResult"> <summary> Returned for a successful UpdateRecordsRequest. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsResult.Records"> <summary> Gets and sets the property Records. A list of records that have been updated. </summary> </member> <member name="P:Amazon.CognitoSync.Model.UpdateRecordsResponse.UpdateRecordsResult"> <summary> Gets and sets the UpdateRecordsResult property. Represents the output of a UpdateRecords operation. </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.BulkPublishRequestMarshaller"> <summary> BulkPublish Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.BulkPublishResponseUnmarshaller"> <summary> Response Unmarshaller for BulkPublish operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.CognitoStreamsMarshaller"> <summary> CognitoStreams Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.CognitoStreamsUnmarshaller"> <summary> Response Unmarshaller for CognitoStreams Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DatasetUnmarshaller"> <summary> Response Unmarshaller for Dataset Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DeleteDatasetRequestMarshaller"> <summary> DeleteDataset Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DeleteDatasetResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDataset operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeDatasetRequestMarshaller"> <summary> DescribeDataset Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeDatasetResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDataset operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeIdentityPoolUsageRequestMarshaller"> <summary> DescribeIdentityPoolUsage Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeIdentityPoolUsageResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIdentityPoolUsage operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeIdentityUsageRequestMarshaller"> <summary> DescribeIdentityUsage Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.DescribeIdentityUsageResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeIdentityUsage operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetBulkPublishDetailsRequestMarshaller"> <summary> GetBulkPublishDetails Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetBulkPublishDetailsResponseUnmarshaller"> <summary> Response Unmarshaller for GetBulkPublishDetails operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetCognitoEventsRequestMarshaller"> <summary> GetCognitoEvents Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetCognitoEventsResponseUnmarshaller"> <summary> Response Unmarshaller for GetCognitoEvents operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetIdentityPoolConfigurationRequestMarshaller"> <summary> GetIdentityPoolConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.GetIdentityPoolConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for GetIdentityPoolConfiguration operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.IdentityPoolUsageUnmarshaller"> <summary> Response Unmarshaller for IdentityPoolUsage Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.IdentityUsageUnmarshaller"> <summary> Response Unmarshaller for IdentityUsage Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.KinesisStreamingMarshaller"> <summary> KinesisStreaming Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.KinesisStreamingUnmarshaller"> <summary> Response Unmarshaller for KinesisStreaming Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListDatasetsRequestMarshaller"> <summary> ListDatasets Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListDatasetsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDatasets operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListIdentityPoolUsageRequestMarshaller"> <summary> ListIdentityPoolUsage Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListIdentityPoolUsageResponseUnmarshaller"> <summary> Response Unmarshaller for ListIdentityPoolUsage operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListRecordsRequestMarshaller"> <summary> ListRecords Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.ListRecordsResponseUnmarshaller"> <summary> Response Unmarshaller for ListRecords operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.PushSyncMarshaller"> <summary> PushSync Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.PushSyncUnmarshaller"> <summary> Response Unmarshaller for PushSync Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.RecordPatchMarshaller"> <summary> RecordPatch Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.RecordUnmarshaller"> <summary> Response Unmarshaller for Record Object </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.RegisterDeviceRequestMarshaller"> <summary> RegisterDevice Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.RegisterDeviceResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterDevice operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SetCognitoEventsRequestMarshaller"> <summary> SetCognitoEvents Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SetCognitoEventsResponseUnmarshaller"> <summary> Response Unmarshaller for SetCognitoEvents operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SetIdentityPoolConfigurationRequestMarshaller"> <summary> SetIdentityPoolConfiguration Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SetIdentityPoolConfigurationResponseUnmarshaller"> <summary> Response Unmarshaller for SetIdentityPoolConfiguration operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SubscribeToDatasetRequestMarshaller"> <summary> SubscribeToDataset Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.SubscribeToDatasetResponseUnmarshaller"> <summary> Response Unmarshaller for SubscribeToDataset operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.UnsubscribeFromDatasetRequestMarshaller"> <summary> UnsubscribeFromDataset Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.UnsubscribeFromDatasetResponseUnmarshaller"> <summary> Response Unmarshaller for UnsubscribeFromDataset operation </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.UpdateRecordsRequestMarshaller"> <summary> UpdateRecords Request Marshaller </summary> </member> <member name="T:Amazon.CognitoSync.Model.Internal.MarshallTransformations.UpdateRecordsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateRecords operation </summary> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormationClient"> <summary> Implementation for accessing CloudFormation AWS CloudFormation <para> AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure. </para> <para> With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/cloudformation/">CloudFormation Product Page</a>. </para> <para> Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://docs.aws.amazon.com/documentation/">http://docs.aws.amazon.com/documentation/</a>. </para> </summary> </member> <member name="T:Amazon.CloudFormation.IAmazonCloudFormation"> <summary> Interface for accessing CloudFormation AWS CloudFormation <para> AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure. </para> <para> With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you. </para> <para> For more information about this product, go to the <a href="http://aws.amazon.com/cloudformation/">CloudFormation Product Page</a>. </para> <para> Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://docs.aws.amazon.com/documentation/">http://docs.aws.amazon.com/documentation/</a>. </para> </summary> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack service method.</param> <returns>The response from the CancelUpdateStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginCancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelUpdateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndCancelUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelUpdateStack.</param> <returns>Returns a CancelUpdateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest)"> <summary> For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. <para> A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. </para> </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback service method.</param> <returns>The response from the ContinueUpdateRollback service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndContinueUpdateRollback operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndContinueUpdateRollback(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginContinueUpdateRollback.</param> <returns>Returns a ContinueUpdateRollbackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"> Resource with the name requested already exists. </exception> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"> Quota for the resource has already been reached. </exception> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginCreateStack(Amazon.CloudFormation.Model.CreateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndCreateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStack.</param> <returns>Returns a CreateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndDeleteStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStack.</param> <returns>Returns a DeleteStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest)"> <summary> Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudFormation.IAmazonCloudFormation.EndDescribeAccountLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountLimits.</param> <returns>Returns a DescribeAccountLimitsResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents service method.</param> <returns>The response from the DescribeStackEvents service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndDescribeStackEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackEvents.</param> <returns>Returns a DescribeStackEventsResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource service method.</param> <returns>The response from the DescribeStackResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndDescribeStackResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResource.</param> <returns>Returns a DescribeStackResourceResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note> <para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para> <para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. </para> <note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources service method.</param> <returns>The response from the DescribeStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndDescribeStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStackResources operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResources.</param> <returns>Returns a DescribeStackResourcesResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStacks"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginDescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndDescribeStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStacks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStacks.</param> <returns>Returns a DescribeStacksResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost service method.</param> <returns>The response from the EstimateTemplateCost service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginEstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndEstimateTemplateCost(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EstimateTemplateCost operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEstimateTemplateCost.</param> <returns>Returns a EstimateTemplateCostResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy service method.</param> <returns>The response from the GetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginGetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndGetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStackPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStackPolicy.</param> <returns>Returns a GetStackPolicyResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para> <note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate service method.</param> <returns>The response from the GetTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginGetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndGetTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTemplate operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplate.</param> <returns>Returns a GetTemplateResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.GetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest)"> <summary> Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para> <para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary service method.</param> <returns>The response from the GetTemplateSummary service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginGetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTemplateSummary operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndGetTemplateSummary(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplateSummary.</param> <returns>Returns a GetTemplateSummaryResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources service method.</param> <returns>The response from the ListStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndListStackResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStackResources operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStackResources.</param> <returns>Returns a ListStackResourcesResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStacks"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <param name="request">Container for the necessary parameters to execute the ListStacks service method.</param> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginListStacks(Amazon.CloudFormation.Model.ListStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStacks operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndListStacks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStacks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStacks.</param> <returns>Returns a ListStacksResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> Sets a stack policy for a specified stack. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy service method.</param> <returns>The response from the SetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginSetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetStackPolicy operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndSetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStackPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStackPolicy.</param> <returns>Returns a SetStackPolicyResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.SignalResource(Amazon.CloudFormation.Model.SignalResourceRequest)"> <summary> Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource service method.</param> <returns>The response from the SignalResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginSignalResource(Amazon.CloudFormation.Model.SignalResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SignalResource operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSignalResource operation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.EndSignalResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SignalResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSignalResource.</param> <returns>Returns a SignalResourceResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para> <para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginUpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStack.</param> <returns>Returns a UpdateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ValidateTemplate"> <summary> Validates a specified template. </summary> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> Validates a specified template. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate service method.</param> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.IAmazonCloudFormation.BeginValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudFormation.EndValidateTemplate(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidateTemplate operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateTemplate.</param> <returns>Returns a ValidateTemplateResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Credentials and an AmazonCloudFormationClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.#ctor(System.String,System.String,System.String,Amazon.CloudFormation.AmazonCloudFormationConfig)"> <summary> Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudFormationClient Configuration Object</param> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest)"> <summary> Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack service method.</param> <returns>The response from the CancelUpdateStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginCancelUpdateStack(Amazon.CloudFormation.Model.CancelUpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelUpdateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelUpdateStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndCancelUpdateStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelUpdateStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelUpdateStack.</param> <returns>Returns a CancelUpdateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest)"> <summary> For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. <para> A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. </para> </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback service method.</param> <returns>The response from the ContinueUpdateRollback service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginContinueUpdateRollback(Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="request">Container for the necessary parameters to execute the ContinueUpdateRollback operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndContinueUpdateRollback operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndContinueUpdateRollback(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ContinueUpdateRollback operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginContinueUpdateRollback.</param> <returns>Returns a ContinueUpdateRollbackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.CreateStack(Amazon.CloudFormation.Model.CreateStackRequest)"> <summary> Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack service method.</param> <returns>The response from the CreateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.AlreadyExistsException"> Resource with the name requested already exists. </exception> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> <exception cref="T:Amazon.CloudFormation.Model.LimitExceededException"> Quota for the resource has already been reached. </exception> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginCreateStack(Amazon.CloudFormation.Model.CreateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateStack.</param> <returns>Returns a CreateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest)"> <summary> Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack service method.</param> <returns>The response from the DeleteStack service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDeleteStack(Amazon.CloudFormation.Model.DeleteStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStack operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStack operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndDeleteStack(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStack operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteStack.</param> <returns>Returns a DeleteStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest)"> <summary> Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits service method.</param> <returns>The response from the DescribeAccountLimits service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeAccountLimits(Amazon.CloudFormation.Model.DescribeAccountLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountLimits operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudFormation.AmazonCloudFormationClient.EndDescribeAccountLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountLimits.</param> <returns>Returns a DescribeAccountLimitsResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest)"> <summary> Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents service method.</param> <returns>The response from the DescribeStackEvents service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackEvents(Amazon.CloudFormation.Model.DescribeStackEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackEvents operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackEvents.</param> <returns>Returns a DescribeStackEventsResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest)"> <summary> Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource service method.</param> <returns>The response from the DescribeStackResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackResource(Amazon.CloudFormation.Model.DescribeStackResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResource operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResource.</param> <returns>Returns a DescribeStackResourceResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest)"> <summary> Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note> <para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para> <para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. </para> <note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources service method.</param> <returns>The response from the DescribeStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStackResources(Amazon.CloudFormation.Model.DescribeStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStackResources operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStackResources.</param> <returns>Returns a DescribeStackResourcesResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.DescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest)"> <summary> Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks service method.</param> <returns>The response from the DescribeStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginDescribeStacks(Amazon.CloudFormation.Model.DescribeStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStacks operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStacks.</param> <returns>Returns a DescribeStacksResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest)"> <summary> Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost service method.</param> <returns>The response from the EstimateTemplateCost service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginEstimateTemplateCost(Amazon.CloudFormation.Model.EstimateTemplateCostRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EstimateTemplateCost operation. </summary> <param name="request">Container for the necessary parameters to execute the EstimateTemplateCost operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEstimateTemplateCost.</param> <returns>Returns a EstimateTemplateCostResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest)"> <summary> Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy service method.</param> <returns>The response from the GetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginGetStackPolicy(Amazon.CloudFormation.Model.GetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the GetStackPolicy operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetStackPolicy.</param> <returns>Returns a GetStackPolicyResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest)"> <summary> Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para> <note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate service method.</param> <returns>The response from the GetTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginGetTemplate(Amazon.CloudFormation.Model.GetTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplate operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplate.</param> <returns>Returns a GetTemplateResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.GetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest)"> <summary> Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para> <para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary service method.</param> <returns>The response from the GetTemplateSummary service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginGetTemplateSummary(Amazon.CloudFormation.Model.GetTemplateSummaryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTemplateSummary operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTemplateSummary operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndGetTemplateSummary(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTemplateSummary operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTemplateSummary.</param> <returns>Returns a GetTemplateSummaryResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest)"> <summary> Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources service method.</param> <returns>The response from the ListStackResources service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginListStackResources(Amazon.CloudFormation.Model.ListStackResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStackResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStackResources operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStackResources.</param> <returns>Returns a ListStackResourcesResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ListStacks(Amazon.CloudFormation.Model.ListStacksRequest)"> <summary> Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> <param name="request">Container for the necessary parameters to execute the ListStacks service method.</param> <returns>The response from the ListStacks service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginListStacks(Amazon.CloudFormation.Model.ListStacksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStacks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStacks operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStacks.</param> <returns>Returns a ListStacksResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest)"> <summary> Sets a stack policy for a specified stack. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy service method.</param> <returns>The response from the SetStackPolicy service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginSetStackPolicy(Amazon.CloudFormation.Model.SetStackPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStackPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStackPolicy operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetStackPolicy operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndSetStackPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStackPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStackPolicy.</param> <returns>Returns a SetStackPolicyResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.SignalResource(Amazon.CloudFormation.Model.SignalResourceRequest)"> <summary> Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource service method.</param> <returns>The response from the SignalResource service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginSignalResource(Amazon.CloudFormation.Model.SignalResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SignalResource operation. </summary> <param name="request">Container for the necessary parameters to execute the SignalResource operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSignalResource operation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.EndSignalResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SignalResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSignalResource.</param> <returns>Returns a SignalResourceResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.UpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest)"> <summary> Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para> <para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack service method.</param> <returns>The response from the UpdateStack service method, as returned by CloudFormation.</returns> <exception cref="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> The template contains resources with capabilities that were not specified in the Capabilities parameter. </exception> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginUpdateStack(Amazon.CloudFormation.Model.UpdateStackRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStack operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStack operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStack.</param> <returns>Returns a UpdateStackResult from CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplate"> <summary> Validates a specified template. </summary> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.ValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest)"> <summary> Validates a specified template. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate service method.</param> <returns>The response from the ValidateTemplate service method, as returned by CloudFormation.</returns> </member> <member name="M:Amazon.CloudFormation.AmazonCloudFormationClient.BeginValidateTemplate(Amazon.CloudFormation.Model.ValidateTemplateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidateTemplate operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidateTemplate operation on AmazonCloudFormationClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidateTemplate.</param> <returns>Returns a ValidateTemplateResult from CloudFormation.</returns> </member> <member name="T:Amazon.CloudFormation.AmazonCloudFormationConfig"> <summary> Configuration for accessing Amazon 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.Capability"> <summary> Constants used for properties of type Capability. </summary> </member> <member name="F:Amazon.CloudFormation.Capability.CAPABILITY_IAM"> <summary> Constant CAPABILITY_IAM for Capability </summary> </member> <member name="M:Amazon.CloudFormation.Capability.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFormation.Capability.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFormation.OnFailure"> <summary> Constants used for properties of type OnFailure. </summary> </member> <member name="F:Amazon.CloudFormation.OnFailure.DELETE"> <summary> Constant DELETE for OnFailure </summary> </member> <member name="F:Amazon.CloudFormation.OnFailure.DO_NOTHING"> <summary> Constant DO_NOTHING for OnFailure </summary> </member> <member name="F:Amazon.CloudFormation.OnFailure.ROLLBACK"> <summary> Constant ROLLBACK for OnFailure </summary> </member> <member name="M:Amazon.CloudFormation.OnFailure.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFormation.OnFailure.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFormation.ResourceSignalStatus"> <summary> Constants used for properties of type ResourceSignalStatus. </summary> </member> <member name="F:Amazon.CloudFormation.ResourceSignalStatus.FAILURE"> <summary> Constant FAILURE for ResourceSignalStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceSignalStatus.SUCCESS"> <summary> Constant SUCCESS for ResourceSignalStatus </summary> </member> <member name="M:Amazon.CloudFormation.ResourceSignalStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFormation.ResourceSignalStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFormation.ResourceStatus"> <summary> Constants used for properties of type ResourceStatus. </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.CREATE_COMPLETE"> <summary> Constant CREATE_COMPLETE for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.CREATE_FAILED"> <summary> Constant CREATE_FAILED for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.CREATE_IN_PROGRESS"> <summary> Constant CREATE_IN_PROGRESS for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.DELETE_COMPLETE"> <summary> Constant DELETE_COMPLETE for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.DELETE_FAILED"> <summary> Constant DELETE_FAILED for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.DELETE_IN_PROGRESS"> <summary> Constant DELETE_IN_PROGRESS for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.DELETE_SKIPPED"> <summary> Constant DELETE_SKIPPED for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.UPDATE_COMPLETE"> <summary> Constant UPDATE_COMPLETE for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.UPDATE_FAILED"> <summary> Constant UPDATE_FAILED for ResourceStatus </summary> </member> <member name="F:Amazon.CloudFormation.ResourceStatus.UPDATE_IN_PROGRESS"> <summary> Constant UPDATE_IN_PROGRESS for ResourceStatus </summary> </member> <member name="M:Amazon.CloudFormation.ResourceStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFormation.ResourceStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFormation.StackStatus"> <summary> Constants used for properties of type StackStatus. </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.CREATE_COMPLETE"> <summary> Constant CREATE_COMPLETE for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.CREATE_FAILED"> <summary> Constant CREATE_FAILED for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.CREATE_IN_PROGRESS"> <summary> Constant CREATE_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.DELETE_COMPLETE"> <summary> Constant DELETE_COMPLETE for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.DELETE_FAILED"> <summary> Constant DELETE_FAILED for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.DELETE_IN_PROGRESS"> <summary> Constant DELETE_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.ROLLBACK_COMPLETE"> <summary> Constant ROLLBACK_COMPLETE for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.ROLLBACK_FAILED"> <summary> Constant ROLLBACK_FAILED for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.ROLLBACK_IN_PROGRESS"> <summary> Constant ROLLBACK_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_COMPLETE"> <summary> Constant UPDATE_COMPLETE for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"> <summary> Constant UPDATE_COMPLETE_CLEANUP_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_IN_PROGRESS"> <summary> Constant UPDATE_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_ROLLBACK_COMPLETE"> <summary> Constant UPDATE_ROLLBACK_COMPLETE for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"> <summary> Constant UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_ROLLBACK_FAILED"> <summary> Constant UPDATE_ROLLBACK_FAILED for StackStatus </summary> </member> <member name="F:Amazon.CloudFormation.StackStatus.UPDATE_ROLLBACK_IN_PROGRESS"> <summary> Constant UPDATE_ROLLBACK_IN_PROGRESS for StackStatus </summary> </member> <member name="M:Amazon.CloudFormation.StackStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFormation.StackStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="M:Amazon.CloudFormation.Internal.ProcessRequestHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.CloudFormation.Internal.ProcessRequestHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="T:Amazon.CloudFormation.Model.AccountLimit"> <summary> The AccountLimit data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.AccountLimit.Name"> <summary> Gets and sets the property Name. <para> The name of the account limit. Currently, the only account limit is <code>StackLimit</code>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.AccountLimit.Value"> <summary> Gets and sets the property Value. <para> The value that is associated with the account limit name. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.AlreadyExistsException"> <summary> CloudFormation 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.AmazonCloudFormationRequest"> <summary> Base class for CloudFormation operation requests. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CancelUpdateStackRequest"> <summary> Container for the parameters to the CancelUpdateStack operation. Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration. <note>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CancelUpdateStackRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest"> <summary> Container for the parameters to the ContinueUpdateRollback operation. For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again. <para> A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ContinueUpdateRollbackRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique ID of the stack that you want to continue rolling back. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse"> <summary> Configuration for accessing Amazon ContinueUpdateRollback service </summary> </member> <member name="T:Amazon.CloudFormation.Model.ContinueUpdateRollbackResult"> <summary> The output for a <a>ContinueUpdateRollback</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ContinueUpdateRollbackResponse.ContinueUpdateRollbackResult"> <summary> Gets and sets the ContinueUpdateRollbackResult property. Represents the output of a ContinueUpdateRollback operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackRequest"> <summary> Container for the parameters to the CreateStack operation. Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API. </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Capabilities"> <summary> Gets and sets the property Capabilities. <para> A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. </para> <para> Currently, the only valid value is <code>CAPABILITY_IAM</code>, which is required for the following resources: <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>. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.DisableRollback"> <summary> Gets and sets the property DisableRollback. <para> Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.NotificationARNs"> <summary> Gets and sets the property NotificationARNs. <para> 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> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.OnFailure"> <summary> Gets and sets the property OnFailure. <para> Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both. </para> <para> Default: <code>ROLLBACK</code> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.ResourceTypes"> <summary> Gets and sets the property ResourceTypes. <para> The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i></code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i></code> (for a specific AWS resource). </para> <para> If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with AWS Identity and Access Management</a>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name that is associated with the stack. The name must be unique in the region in which you are creating the stack. </para> <note>A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.</note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackPolicyBody"> <summary> Gets and sets the property StackPolicyBody. <para> 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 can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.StackPolicyURL"> <summary> Gets and sets the property StackPolicyURL. <para> 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 can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.Tags"> <summary> Gets and sets the property Tags. <para> Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. 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> <para> Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TemplateURL"> <summary> Gets and sets the property TemplateURL. <para> Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. 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. </para> <para> Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackRequest.TimeoutInMinutes"> <summary> Gets and sets the property TimeoutInMinutes. <para> The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackResponse"> <summary> Configuration for accessing Amazon CreateStack service </summary> </member> <member name="T:Amazon.CloudFormation.Model.CreateStackResult"> <summary> The output for a <a>CreateStack</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackResult.StackId"> <summary> Gets and sets the property StackId. <para> Unique identifier of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.CreateStackResponse.CreateStackResult"> <summary> Gets and sets the CreateStackResult property. Represents the output of a CreateStack operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DeleteStackRequest"> <summary> Container for the parameters to the DeleteStack operation. Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DeleteStackRequest.RetainResources"> <summary> Gets and sets the property RetainResources. <para> For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources. </para> <para> Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DeleteStackRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeAccountLimitsRequest"> <summary> Container for the parameters to the DescribeAccountLimits operation. Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeAccountLimitsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that identifies the next page of limits that you want to retrieve. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeAccountLimitsResponse"> <summary> Configuration for accessing Amazon DescribeAccountLimits service </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeAccountLimitsResult"> <summary> The output for the <a>DescribeAccountLimits</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeAccountLimitsResult.AccountLimits"> <summary> Gets and sets the property AccountLimits. <para> An account limit structure that contain a list of AWS CloudFormation account limits and their values. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeAccountLimitsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeAccountLimitsResponse.DescribeAccountLimitsResult"> <summary> Gets and sets the DescribeAccountLimitsResult property. Represents the output of a DescribeAccountLimits operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsRequest"> <summary> Container for the parameters to the DescribeStackEvents operation. Returns all stack related events for a specified stack. For more information about a stack's event history, go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the AWS CloudFormation User Guide. <note>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that identifies the next page of events that you want to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsResponse"> <summary> Configuration for accessing Amazon DescribeStackEvents service </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackEventsResult"> <summary> The output for a <a>DescribeStackEvents</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResult.StackEvents"> <summary> Gets and sets the property StackEvents. <para> A list of <code>StackEvents</code> structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackEventsResponse.DescribeStackEventsResult"> <summary> Gets and sets the DescribeStackEventsResult property. Represents the output of a DescribeStackEvents operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceRequest"> <summary> Container for the parameters to the DescribeStackResource operation. Returns a description of the specified resource in the specified stack. <para> For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceRequest.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource as specified in the template. </para> <para> Default: There is no default value. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceResponse"> <summary> Configuration for accessing Amazon DescribeStackResource service </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourceResult"> <summary> The output for a <a>DescribeStackResource</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceResult.StackResourceDetail"> <summary> Gets and sets the property StackResourceDetail. <para> A <code>StackResourceDetail</code> structure containing the description of the specified resource in the specified stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourceResponse.DescribeStackResourceResult"> <summary> Gets and sets the DescribeStackResourceResult property. Represents the output of a DescribeStackResource operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesRequest"> <summary> Container for the parameters to the DescribeStackResources operation. Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned. <note>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</note> <para> For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted. </para> <para> You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">AWS CloudFormation User Guide</a>. </para> <note>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource as specified in the template. </para> <para> Default: There is no default value. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.PhysicalResourceId"> <summary> Gets and sets the property PhysicalResourceId. <para> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </para> <para> For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack. </para> <para> Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>. </para> <para> Default: There is no default value. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> <para> Required: Conditional. If you do not specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesResponse"> <summary> Configuration for accessing Amazon DescribeStackResources service </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStackResourcesResult"> <summary> The output for a <a>DescribeStackResources</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesResult.StackResources"> <summary> Gets and sets the property StackResources. <para> A list of <code>StackResource</code> structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStackResourcesResponse.DescribeStackResourcesResult"> <summary> Gets and sets the DescribeStackResourcesResult property. Represents the output of a DescribeStackResources operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksRequest"> <summary> Container for the parameters to the DescribeStacks operation. Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that identifies the next page of stacks that you want to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksResponse"> <summary> Configuration for accessing Amazon DescribeStacks service </summary> </member> <member name="T:Amazon.CloudFormation.Model.DescribeStacksResult"> <summary> The output for a <a>DescribeStacks</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResult.Stacks"> <summary> Gets and sets the property Stacks. <para> A list of stack structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.DescribeStacksResponse.DescribeStacksResult"> <summary> Gets and sets the DescribeStacksResult property. Represents the output of a DescribeStacks operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostRequest"> <summary> Container for the parameters to the EstimateTemplateCost operation. Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of <code>Parameter</code> structures that specify input parameters. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (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> <para> Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostRequest.TemplateURL"> <summary> Gets and sets the property TemplateURL. <para> Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. 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> <para> Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostResponse"> <summary> Configuration for accessing Amazon EstimateTemplateCost service </summary> </member> <member name="T:Amazon.CloudFormation.Model.EstimateTemplateCostResult"> <summary> The output for a <a>EstimateTemplateCost</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostResult.Url"> <summary> Gets and sets the property Url. <para> An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.EstimateTemplateCostResponse.EstimateTemplateCostResult"> <summary> Gets and sets the EstimateTemplateCostResult property. Represents the output of a EstimateTemplateCost operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyRequest"> <summary> Container for the parameters to the GetStackPolicy operation. Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or unique stack ID that is associated with the stack whose policy you want to get. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyResponse"> <summary> Configuration for accessing Amazon GetStackPolicy service </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetStackPolicyResult"> <summary> The output for the <a>GetStackPolicy</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyResult.StackPolicyBody"> <summary> Gets and sets the property StackPolicyBody. <para> 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> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetStackPolicyResponse.GetStackPolicyResult"> <summary> Gets and sets the GetStackPolicyResult property. Represents the output of a GetStackPolicy operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateRequest"> <summary> Container for the parameters to the GetTemplate operation. Returns the template body for a specified stack. You can get the template for running or deleted stacks. <para> For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted. </para> <note> If the template does not exist, a <code>ValidationError</code> is returned. </note> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateResponse"> <summary> Configuration for accessing Amazon GetTemplate service </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateResult"> <summary> The output for <a>GetTemplate</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateResult.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> 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> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateResponse.GetTemplateResult"> <summary> Gets and sets the GetTemplateResult property. Represents the output of a GetTemplate operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateSummaryRequest"> <summary> Container for the parameters to the GetTemplateSummary operation. Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack. <para> You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack. </para> <para> For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. </para> <para> Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryRequest.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. </para> <para> Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryRequest.TemplateURL"> <summary> Gets and sets the property TemplateURL. <para> Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the AWS CloudFormation User Guide. </para> <para> Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateSummaryResponse"> <summary> Configuration for accessing Amazon GetTemplateSummary service </summary> </member> <member name="T:Amazon.CloudFormation.Model.GetTemplateSummaryResult"> <summary> The output for the <a>GetTemplateSummary</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.Capabilities"> <summary> Gets and sets the property Capabilities. <para> The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. 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. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.CapabilitiesReason"> <summary> Gets and sets the property CapabilitiesReason. <para> The list of resources that generated the values in the <code>Capabilities</code> response element. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.Description"> <summary> Gets and sets the property Description. <para> The value that is defined in the <code>Description</code> property of the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.Metadata"> <summary> Gets and sets the property Metadata. <para> The value that is defined for the <code>Metadata</code> property of the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of parameter declarations that describe various properties for each parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.ResourceTypes"> <summary> Gets and sets the property ResourceTypes. <para> A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResult.Version"> <summary> Gets and sets the property Version. <para> The AWS template format version, which identifies the capabilities of the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.GetTemplateSummaryResponse.GetTemplateSummaryResult"> <summary> Gets and sets the GetTemplateSummaryResult property. Represents the output of a GetTemplateSummary operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.InsufficientCapabilitiesException"> <summary> CloudFormation 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.LimitExceededException"> <summary> CloudFormation 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. Returns descriptions of all resources of the specified stack. <para> For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that identifies the next page of stack resources that you want to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or the unique stack ID that is associated with the stack, which are not always interchangeable: </para> <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> <para> Default: There is no default value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStackResourcesResponse"> <summary> Configuration for accessing Amazon ListStackResources service </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStackResourcesResult"> <summary> The output for a <a>ListStackResources</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the output exceeds 1 MB in size, a string that identifies the next page of stack resources. If no additional page exists, this value is null. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResult.StackResourceSummaries"> <summary> Gets and sets the property StackResourceSummaries. <para> A list of <code>StackResourceSummary</code> structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStackResourcesResponse.ListStackResourcesResult"> <summary> Gets and sets the ListStackResourcesResult property. Represents the output of a ListStackResources operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksRequest"> <summary> Container for the parameters to the ListStacks operation. Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted). </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string that identifies the next page of stacks that you want to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksRequest.StackStatusFilter"> <summary> Gets and sets the property StackStatusFilter. <para> 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 <code>StackStatus</code> parameter of the <a>Stack</a> data type. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksResponse"> <summary> Configuration for accessing Amazon ListStacks service </summary> </member> <member name="T:Amazon.CloudFormation.Model.ListStacksResult"> <summary> The output for <a>ListStacks</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResult.StackSummaries"> <summary> Gets and sets the property StackSummaries. <para> A list of <code>StackSummary</code> structures containing information about the specified stacks. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ListStacksResponse.ListStacksResult"> <summary> Gets and sets the ListStacksResult property. Represents the output of a ListStacks operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.Output"> <summary> The Output data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Output.Description"> <summary> Gets and sets the property Description. <para> User defined description associated with the output. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Output.OutputKey"> <summary> Gets and sets the property OutputKey. <para> The key associated with the output. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Output.OutputValue"> <summary> Gets and sets the property OutputValue. <para> The value associated with the output. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.Parameter"> <summary> The Parameter data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Parameter.ParameterKey"> <summary> Gets and sets the property ParameterKey. <para> The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Parameter.ParameterValue"> <summary> Gets and sets the property ParameterValue. <para> The value associated with the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Parameter.UsePreviousValue"> <summary> Gets and sets the property UsePreviousValue. <para> During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify <code>true</code>, do not specify a parameter value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ParameterConstraints"> <summary> A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the <code>AllowedValues</code> property. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterConstraints.AllowedValues"> <summary> Gets and sets the property AllowedValues. <para> A list of values that are permitted for a parameter. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ParameterDeclaration"> <summary> The ParameterDeclaration data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value of the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.Description"> <summary> Gets and sets the property Description. <para> The description that is associate with the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.NoEcho"> <summary> Gets and sets the property NoEcho. <para> Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.ParameterConstraints"> <summary> Gets and sets the property ParameterConstraints. <para> The criteria that AWS CloudFormation uses to validate parameter values. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.ParameterKey"> <summary> Gets and sets the property ParameterKey. <para> The name that is associated with the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ParameterDeclaration.ParameterType"> <summary> Gets and sets the property ParameterType. <para> The type of parameter. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.SetStackPolicyRequest"> <summary> Container for the parameters to the SetStackPolicy operation. Sets a stack policy for a specified stack. </summary> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or unique stack ID that you want to associate a policy with. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackPolicyBody"> <summary> Gets and sets the property StackPolicyBody. <para> 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 can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SetStackPolicyRequest.StackPolicyURL"> <summary> Gets and sets the property StackPolicyURL. <para> 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 can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.SignalResourceRequest"> <summary> Container for the parameters to the SignalResource operation. Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance. </summary> </member> <member name="P:Amazon.CloudFormation.Model.SignalResourceRequest.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SignalResourceRequest.StackName"> <summary> Gets and sets the property StackName. <para> The stack name or unique stack ID that includes the resource that you want to signal. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SignalResourceRequest.Status"> <summary> Gets and sets the property Status. <para> The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.SignalResourceRequest.UniqueId"> <summary> Gets and sets the property UniqueId. <para> A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.Stack"> <summary> The Stack data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Capabilities"> <summary> Gets and sets the property Capabilities. <para> The capabilities allowed in the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.CreationTime"> <summary> Gets and sets the property CreationTime. <para> The time at which the stack was created. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Description"> <summary> Gets and sets the property Description. <para> A user-defined description associated with the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.DisableRollback"> <summary> Gets and sets the property DisableRollback. <para> Boolean to enable or disable rollback on stack creation failures: </para> <para> <ul> <li><code>true</code>: disable rollback</li> <li><code>false</code>: enable rollback</li> </ul> </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.LastUpdatedTime"> <summary> Gets and sets the property LastUpdatedTime. <para> The time the stack was last updated. This field will only be returned if the stack has been updated at least once. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.NotificationARNs"> <summary> Gets and sets the property NotificationARNs. <para> SNS topic ARNs to which stack related events are published. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Outputs"> <summary> Gets and sets the property Outputs. <para> A list of output structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of <code>Parameter</code> structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackId"> <summary> Gets and sets the property StackId. <para> Unique identifier of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackName"> <summary> Gets and sets the property StackName. <para> The name associated with the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackStatus"> <summary> Gets and sets the property StackStatus. <para> Current status of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.StackStatusReason"> <summary> Gets and sets the property StackStatusReason. <para> Success/failure message associated with the stack status. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.Tags"> <summary> Gets and sets the property Tags. <para> A list of <code>Tag</code>s that specify cost allocation information for the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Stack.TimeoutInMinutes"> <summary> Gets and sets the property TimeoutInMinutes. <para> The amount of time within which stack creation should complete. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackEvent"> <summary> The StackEvent data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.EventId"> <summary> Gets and sets the property EventId. <para> The unique ID of this event. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource specified in the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.PhysicalResourceId"> <summary> Gets and sets the property PhysicalResourceId. <para> The name or unique identifier associated with the physical instance of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceProperties"> <summary> Gets and sets the property ResourceProperties. <para> BLOB of the properties used to create the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceStatus"> <summary> Gets and sets the property ResourceStatus. <para> Current status of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceStatusReason"> <summary> Gets and sets the property ResourceStatusReason. <para> Success/failure message associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.ResourceType"> <summary> Gets and sets the property ResourceType. <para> 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.) </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.StackId"> <summary> Gets and sets the property StackId. <para> The unique ID name of the instance of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.StackName"> <summary> Gets and sets the property StackName. <para> The name associated with a stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackEvent.Timestamp"> <summary> Gets and sets the property Timestamp. <para> Time the status was updated. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResource"> <summary> The StackResource data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.Description"> <summary> Gets and sets the property Description. <para> User defined description associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource specified in the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.PhysicalResourceId"> <summary> Gets and sets the property PhysicalResourceId. <para> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceStatus"> <summary> Gets and sets the property ResourceStatus. <para> Current status of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceStatusReason"> <summary> Gets and sets the property ResourceStatusReason. <para> Success/failure message associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.ResourceType"> <summary> Gets and sets the property ResourceType. <para> 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.) </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.StackId"> <summary> Gets and sets the property StackId. <para> Unique identifier of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.StackName"> <summary> Gets and sets the property StackName. <para> The name associated with the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResource.Timestamp"> <summary> Gets and sets the property Timestamp. <para> Time the status was updated. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResourceDetail"> <summary> Contains detailed information about the specified stack resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.Description"> <summary> Gets and sets the property Description. <para> User defined description associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.LastUpdatedTimestamp"> <summary> Gets and sets the property LastUpdatedTimestamp. <para> Time the status was updated. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource specified in the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.Metadata"> <summary> Gets and sets the property Metadata. <para> The JSON format content of the <code>Metadata</code> 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. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.PhysicalResourceId"> <summary> Gets and sets the property PhysicalResourceId. <para> The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceStatus"> <summary> Gets and sets the property ResourceStatus. <para> Current status of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceStatusReason"> <summary> Gets and sets the property ResourceStatusReason. <para> Success/failure message associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.ResourceType"> <summary> Gets and sets the property ResourceType. <para> 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.) </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.StackId"> <summary> Gets and sets the property StackId. <para> Unique identifier of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceDetail.StackName"> <summary> Gets and sets the property StackName. <para> The name associated with the stack. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackResourceSummary"> <summary> Contains high-level information about the specified stack resource. </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.LastUpdatedTimestamp"> <summary> Gets and sets the property LastUpdatedTimestamp. <para> Time the status was updated. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.LogicalResourceId"> <summary> Gets and sets the property LogicalResourceId. <para> The logical name of the resource specified in the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.PhysicalResourceId"> <summary> Gets and sets the property PhysicalResourceId. <para> The name or unique identifier that corresponds to a physical instance ID of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceStatus"> <summary> Gets and sets the property ResourceStatus. <para> Current status of the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceStatusReason"> <summary> Gets and sets the property ResourceStatusReason. <para> Success/failure message associated with the resource. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackResourceSummary.ResourceType"> <summary> Gets and sets the property ResourceType. <para> 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.) </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.StackSummary"> <summary> The StackSummary Data Type </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.CreationTime"> <summary> Gets and sets the property CreationTime. <para> The time the stack was created. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.DeletionTime"> <summary> Gets and sets the property DeletionTime. <para> The time the stack was deleted. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.LastUpdatedTime"> <summary> Gets and sets the property LastUpdatedTime. <para> The time the stack was last updated. This field will only be returned if the stack has been updated at least once. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackId"> <summary> Gets and sets the property StackId. <para> Unique stack identifier. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackName"> <summary> Gets and sets the property StackName. <para> The name associated with the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackStatus"> <summary> Gets and sets the property StackStatus. <para> The current status of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.StackStatusReason"> <summary> Gets and sets the property StackStatusReason. <para> Success/Failure message associated with the stack status. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.StackSummary.TemplateDescription"> <summary> Gets and sets the property TemplateDescription. <para> The template description of the template used to create the stack. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.Tag"> <summary> The Tag type is used by <code>CreateStack</code> in the <code>Tags</code> 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. </summary> </member> <member name="P:Amazon.CloudFormation.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> <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: <code>aws:</code>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> <i>Required</i>. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.TemplateParameter"> <summary> The TemplateParameter data type. </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value associated with the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.Description"> <summary> Gets and sets the property Description. <para> User defined description associated with the parameter. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.NoEcho"> <summary> Gets and sets the property NoEcho. <para> Flag indicating whether the parameter should be displayed as plain text in logs and UIs. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.TemplateParameter.ParameterKey"> <summary> Gets and sets the property ParameterKey. <para> The name associated with the parameter. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackRequest"> <summary> Container for the parameters to the UpdateStack operation. Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action. <para> To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action. </para> <para> For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>. </para> </summary> <summary> The input for <a>UpdateStack</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.Capabilities"> <summary> Gets and sets the property Capabilities. <para> A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Currently, the only valid value is <code>CAPABILITY_IAM</code>, which is required for the following resources: <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>. If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.NotificationARNs"> <summary> Gets and sets the property NotificationARNs. <para> Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.ResourceTypes"> <summary> Gets and sets the property ResourceTypes. <para> The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. </para> <para> If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html">Controlling Access with AWS Identity and Access Management</a>. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackName"> <summary> Gets and sets the property StackName. <para> The name or unique stack ID of the stack to update. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyBody"> <summary> Gets and sets the property StackPolicyBody. <para> Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> <para> You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyDuringUpdateBody"> <summary> Gets and sets the property StackPolicyDuringUpdateBody. <para> Structure containing the temporary overriding stack policy body. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both. </para> <para> 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> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyDuringUpdateURL"> <summary> Gets and sets the property StackPolicyDuringUpdateURL. <para> 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. You can specify either the <code>StackPolicyDuringUpdateBody</code> or the <code>StackPolicyDuringUpdateURL</code> parameter, but not both. </para> <para> 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> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.StackPolicyURL"> <summary> Gets and sets the property StackPolicyURL. <para> 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. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both. </para> <para> You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.Tags"> <summary> Gets and sets the property Tags. <para> Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags. </para> <para> If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (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> <para> Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.TemplateURL"> <summary> Gets and sets the property TemplateURL. <para> Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. 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> <para> Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackRequest.UsePreviousTemplate"> <summary> Gets and sets the property UsePreviousTemplate. <para> Reuse the existing template that is associated with the stack that you are updating. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackResponse"> <summary> Configuration for accessing Amazon UpdateStack service </summary> </member> <member name="T:Amazon.CloudFormation.Model.UpdateStackResult"> <summary> The output for a <a>UpdateStack</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackResult.StackId"> <summary> Gets and sets the property StackId. <para> Unique identifier of the stack. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.UpdateStackResponse.UpdateStackResult"> <summary> Gets and sets the UpdateStackResult property. Represents the output of a UpdateStack operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateRequest"> <summary> Container for the parameters to the ValidateTemplate operation. Validates a specified template. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateRequest.TemplateBody"> <summary> Gets and sets the property TemplateBody. <para> Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. 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> <para> Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateRequest.TemplateURL"> <summary> Gets and sets the property TemplateURL. <para> Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. 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> <para> Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used. </para> </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateResponse"> <summary> Configuration for accessing Amazon ValidateTemplate service </summary> </member> <member name="T:Amazon.CloudFormation.Model.ValidateTemplateResult"> <summary> The output for <a>ValidateTemplate</a> action. </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Capabilities"> <summary> Gets and sets the property Capabilities. <para> The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. 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. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.CapabilitiesReason"> <summary> Gets and sets the property CapabilitiesReason. <para> The list of resources that generated the values in the <code>Capabilities</code> response element. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Description"> <summary> Gets and sets the property Description. <para> The description found within the template. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResult.Parameters"> <summary> Gets and sets the property Parameters. <para> A list of <code>TemplateParameter</code> structures. </para> </summary> </member> <member name="P:Amazon.CloudFormation.Model.ValidateTemplateResponse.ValidateTemplateResult"> <summary> Gets and sets the ValidateTemplateResult property. Represents the output of a ValidateTemplate operation. </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.AccountLimitUnmarshaller"> <summary> Response Unmarshaller for AccountLimit Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CancelUpdateStackRequestMarshaller"> <summary> CancelUpdateStack 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.ContinueUpdateRollbackRequestMarshaller"> <summary> ContinueUpdateRollback Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ContinueUpdateRollbackResponseUnmarshaller"> <summary> Response Unmarshaller for ContinueUpdateRollback operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.CreateStackRequestMarshaller"> <summary> CreateStack 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.DeleteStackRequestMarshaller"> <summary> DeleteStack 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.DescribeAccountLimitsRequestMarshaller"> <summary> DescribeAccountLimits Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeAccountLimitsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAccountLimits operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.DescribeStackEventsRequestMarshaller"> <summary> DescribeStackEvents 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.DescribeStackResourceRequestMarshaller"> <summary> DescribeStackResource 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.DescribeStackResourcesRequestMarshaller"> <summary> DescribeStackResources 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.DescribeStacksRequestMarshaller"> <summary> DescribeStacks 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.EstimateTemplateCostRequestMarshaller"> <summary> EstimateTemplateCost 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.GetStackPolicyRequestMarshaller"> <summary> GetStackPolicy 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.GetTemplateRequestMarshaller"> <summary> GetTemplate 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.GetTemplateSummaryRequestMarshaller"> <summary> GetTemplateSummary Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.GetTemplateSummaryResponseUnmarshaller"> <summary> Response Unmarshaller for GetTemplateSummary operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ListStackResourcesRequestMarshaller"> <summary> ListStackResources 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.ListStacksRequestMarshaller"> <summary> ListStacks 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.OutputUnmarshaller"> <summary> Response Unmarshaller for Output Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ParameterConstraintsUnmarshaller"> <summary> Response Unmarshaller for ParameterConstraints Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ParameterDeclarationUnmarshaller"> <summary> Response Unmarshaller for ParameterDeclaration Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ParameterUnmarshaller"> <summary> Response Unmarshaller for Parameter Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.SetStackPolicyRequestMarshaller"> <summary> SetStackPolicy 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.SignalResourceRequestMarshaller"> <summary> SignalResource Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.SignalResourceResponseUnmarshaller"> <summary> Response Unmarshaller for SignalResource operation </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackEventUnmarshaller"> <summary> Response Unmarshaller for StackEvent Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceDetailUnmarshaller"> <summary> Response Unmarshaller for StackResourceDetail Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceSummaryUnmarshaller"> <summary> Response Unmarshaller for StackResourceSummary Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackResourceUnmarshaller"> <summary> Response Unmarshaller for StackResource Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackSummaryUnmarshaller"> <summary> Response Unmarshaller for StackSummary Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.StackUnmarshaller"> <summary> Response Unmarshaller for Stack Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.TemplateParameterUnmarshaller"> <summary> Response Unmarshaller for TemplateParameter Object </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.UpdateStackRequestMarshaller"> <summary> UpdateStack 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.ValidateTemplateRequestMarshaller"> <summary> ValidateTemplate Request Marshaller </summary> </member> <member name="T:Amazon.CloudFormation.Model.Internal.MarshallTransformations.ValidateTemplateResponseUnmarshaller"> <summary> Response Unmarshaller for ValidateTemplate operation </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.AmazonCloudFrontClient"> <summary> Implementation for accessing CloudFront </summary> </member> <member name="T:Amazon.CloudFront.IAmazonCloudFront"> <summary> Interface for accessing CloudFront </summary> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.CreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest)"> <summary> Create a new origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the CreateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException"> If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException"> Processing your request would cause you to exceed the maximum number of origin access identities allowed. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginCreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.EndCreateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.CreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest)"> <summary> Create a new distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateDistribution service method.</param> <returns>The response from the CreateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionAlreadyExistsException"> The caller reference you attempted to create the distribution with is associated with another distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidProtocolSettingsException"> You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionsException"> Processing your request would cause you to exceed the maximum number of distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginCreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. </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.IAmazonCloudFront.EndCreateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDistribution operation. </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.IAmazonCloudFront.CreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest)"> <summary> Create a new invalidation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInvalidation service method.</param> <returns>The response from the CreateInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.BatchTooLargeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyInvalidationsInProgressException"> You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginCreateInvalidation(Amazon.CloudFront.Model.CreateInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInvalidation operation. </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.IAmazonCloudFront.EndCreateInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInvalidation operation. </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.IAmazonCloudFront.CreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest)"> <summary> Create a new streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the CreateStreamingDistribution service method.</param> <returns>The response from the CreateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionsException"> Processing your request would cause you to exceed the maximum number of streaming distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginCreateStreamingDistribution(Amazon.CloudFront.Model.CreateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateStreamingDistribution operation. </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.IAmazonCloudFront.EndCreateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateStreamingDistribution operation. </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.IAmazonCloudFront.DeleteCloudFrontOriginAccessIdentity"> <summary> Delete an origin access identity. </summary> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest)"> <summary> Delete an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the DeleteCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityInUseException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginDeleteCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.EndDeleteCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.DeleteDistribution"> <summary> Delete a distribution. </summary> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest)"> <summary> Delete a distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDistribution service method.</param> <returns>The response from the DeleteDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.DistributionNotDisabledException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginDeleteDistribution(Amazon.CloudFront.Model.DeleteDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDistribution operation. </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.IAmazonCloudFront.EndDeleteDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDistribution operation. </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.IAmazonCloudFront.DeleteStreamingDistribution"> <summary> Delete a streaming distribution. </summary> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.DeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest)"> <summary> Delete a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the DeleteStreamingDistribution service method.</param> <returns>The response from the DeleteStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.StreamingDistributionNotDisabledException"> </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginDeleteStreamingDistribution(Amazon.CloudFront.Model.DeleteStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteStreamingDistribution operation. </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.IAmazonCloudFront.EndDeleteStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteStreamingDistribution operation. </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.IAmazonCloudFront.GetCloudFrontOriginAccessIdentity"> <summary> Get the information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest)"> <summary> Get the information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.EndGetCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityConfig"> <summary> Get the configuration information about an origin access identity. </summary> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest)"> <summary> Get the configuration information about an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the GetCloudFrontOriginAccessIdentityConfig service method.</param> <returns>The response from the GetCloudFrontOriginAccessIdentityConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetCloudFrontOriginAccessIdentityConfig(Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. </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.IAmazonCloudFront.EndGetCloudFrontOriginAccessIdentityConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetCloudFrontOriginAccessIdentityConfig operation. </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.IAmazonCloudFront.GetDistribution"> <summary> Get the information about a distribution. </summary> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistribution(Amazon.CloudFront.Model.GetDistributionRequest)"> <summary> Get the information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistribution service method.</param> <returns>The response from the GetDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetDistribution(Amazon.CloudFront.Model.GetDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistribution operation. </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.IAmazonCloudFront.EndGetDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistribution operation. </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.IAmazonCloudFront.GetDistributionConfig"> <summary> Get the configuration information about a distribution. </summary> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest)"> <summary> Get the configuration information about a distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetDistributionConfig service method.</param> <returns>The response from the GetDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetDistributionConfig(Amazon.CloudFront.Model.GetDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDistributionConfig operation. </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.IAmazonCloudFront.EndGetDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDistributionConfig operation. </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.IAmazonCloudFront.GetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest)"> <summary> Get the information about an invalidation. </summary> <param name="request">Container for the necessary parameters to execute the GetInvalidation service method.</param> <returns>The response from the GetInvalidation service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchInvalidationException"> The specified invalidation does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetInvalidation(Amazon.CloudFront.Model.GetInvalidationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetInvalidation operation. </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.IAmazonCloudFront.EndGetInvalidation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetInvalidation operation. </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.IAmazonCloudFront.GetStreamingDistribution"> <summary> Get the information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest)"> <summary> Get the information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistribution service method.</param> <returns>The response from the GetStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetStreamingDistribution(Amazon.CloudFront.Model.GetStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistribution operation. </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.IAmazonCloudFront.EndGetStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistribution operation. </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.IAmazonCloudFront.GetStreamingDistributionConfig"> <summary> Get the configuration information about a streaming distribution. </summary> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.GetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest)"> <summary> Get the configuration information about a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the GetStreamingDistributionConfig service method.</param> <returns>The response from the GetStreamingDistributionConfig service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginGetStreamingDistributionConfig(Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetStreamingDistributionConfig operation. </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.IAmazonCloudFront.EndGetStreamingDistributionConfig(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetStreamingDistributionConfig operation. </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.IAmazonCloudFront.ListCloudFrontOriginAccessIdentities"> <summary> List origin access identities. </summary> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest)"> <summary> List origin access identities. </summary> <param name="request">Container for the necessary parameters to execute the ListCloudFrontOriginAccessIdentities service method.</param> <returns>The response from the ListCloudFrontOriginAccessIdentities service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginListCloudFrontOriginAccessIdentities(Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. </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.IAmazonCloudFront.EndListCloudFrontOriginAccessIdentities(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListCloudFrontOriginAccessIdentities operation. </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.IAmazonCloudFront.ListDistributions"> <summary> List distributions. </summary> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest)"> <summary> List distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListDistributions service method.</param> <returns>The response from the ListDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginListDistributions(Amazon.CloudFront.Model.ListDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDistributions operation. </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.IAmazonCloudFront.EndListDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDistributions operation. </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.IAmazonCloudFront.ListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest)"> <summary> List invalidation batches. </summary> <param name="request">Container for the necessary parameters to execute the ListInvalidations service method.</param> <returns>The response from the ListInvalidations service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginListInvalidations(Amazon.CloudFront.Model.ListInvalidationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListInvalidations operation. </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.IAmazonCloudFront.EndListInvalidations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListInvalidations operation. </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.IAmazonCloudFront.ListStreamingDistributions"> <summary> List streaming distributions. </summary> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.ListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest)"> <summary> List streaming distributions. </summary> <param name="request">Container for the necessary parameters to execute the ListStreamingDistributions service method.</param> <returns>The response from the ListStreamingDistributions service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginListStreamingDistributions(Amazon.CloudFront.Model.ListStreamingDistributionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStreamingDistributions operation. </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.IAmazonCloudFront.EndListStreamingDistributions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStreamingDistributions operation. </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.IAmazonCloudFront.UpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest)"> <summary> Update an origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the UpdateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the UpdateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchCloudFrontOriginAccessIdentityException"> The specified origin access identity does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginUpdateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.EndUpdateCloudFrontOriginAccessIdentity(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateCloudFrontOriginAccessIdentity operation. </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.IAmazonCloudFront.UpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest)"> <summary> Update a distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDistribution service method.</param> <returns>The response from the UpdateDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidDefaultRootObjectException"> The default root object file name is too big or contains an invalid character. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidErrorCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidForwardCookiesException"> Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidGeoRestrictionParameterException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidHeadersForS3OriginException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidLocationCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginUpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. </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.IAmazonCloudFront.EndUpdateDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDistribution operation. </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.IAmazonCloudFront.UpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest)"> <summary> Update a streaming distribution. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStreamingDistribution service method.</param> <returns>The response from the UpdateStreamingDistribution service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.AccessDeniedException"> Access denied. </exception> <exception cref="T:Amazon.CloudFront.Model.CNAMEAlreadyExistsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.IllegalUpdateException"> Origin and CallerReference cannot be updated. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidIfMatchVersionException"> The If-Match version is missing or not valid for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchStreamingDistributionException"> The specified streaming distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyStreamingDistributionCNAMEsException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.IAmazonCloudFront.BeginUpdateStreamingDistribution(Amazon.CloudFront.Model.UpdateStreamingDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStreamingDistribution operation. </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.IAmazonCloudFront.EndUpdateStreamingDistribution(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStreamingDistribution operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStreamingDistribution.</param> <returns>Returns a UpdateStreamingDistributionResult from CloudFront.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Credentials and an AmazonCloudFrontClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFrontClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.#ctor(System.String,System.String,System.String,Amazon.CloudFront.AmazonCloudFrontConfig)"> <summary> Constructs AmazonCloudFrontClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFrontClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudFrontClient Configuration Object</param> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.CreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest)"> <summary> Create a new origin access identity. </summary> <param name="request">Container for the necessary parameters to execute the CreateCloudFrontOriginAccessIdentity service method.</param> <returns>The response from the CreateCloudFrontOriginAccessIdentity service method, as returned by CloudFront.</returns> <exception cref="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityAlreadyExistsException"> If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error. </exception> <exception cref="T:Amazon.CloudFront.Model.InconsistentQuantitiesException"> The value of Quantity and the size of Items do not match. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidArgumentException"> The argument is invalid. </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCloudFrontOriginAccessIdentitiesException"> Processing your request would cause you to exceed the maximum number of origin access identities allowed. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.BeginCreateCloudFrontOriginAccessIdentity(Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCloudFrontOriginAccessIdentity operation. </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. </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.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginException"> The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidProtocolSettingsException"> You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionsException"> Processing your request would cause you to exceed the maximum number of distributions allowed. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.BeginCreateDistribution(Amazon.CloudFront.Model.CreateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDistribution operation. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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. </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.InvalidMinimumProtocolVersionException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidOriginAccessIdentityException"> The origin access identity is not valid or doesn't exist. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRelativePathException"> The relative path is too big, is not URL-encoded, or does not begin with a slash (/). </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidRequiredProtocolException"> This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration. </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidResponseCodeException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidTTLOrderException"> </exception> <exception cref="T:Amazon.CloudFront.Model.InvalidViewerCertificateException"> </exception> <exception cref="T:Amazon.CloudFront.Model.MissingBodyException"> This operation requires a body. Ensure that the body is present and the Content-Type header is set. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchDistributionException"> The specified distribution does not exist. </exception> <exception cref="T:Amazon.CloudFront.Model.NoSuchOriginException"> No origin exists with the specified Origin Id. </exception> <exception cref="T:Amazon.CloudFront.Model.PreconditionFailedException"> The precondition given in one or more of the request-header fields evaluated to false. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCacheBehaviorsException"> You cannot create anymore cache behaviors for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCertificatesException"> You cannot create anymore custom ssl certificates. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyCookieNamesInWhiteListException"> Your request contains more cookie names in the whitelist than are allowed per cache behavior. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyDistributionCNAMEsException"> Your request contains more CNAMEs than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyHeadersInForwardedValuesException"> </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyOriginsException"> You cannot create anymore origins for the distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TooManyTrustedSignersException"> Your request contains more trusted signers than are allowed per distribution. </exception> <exception cref="T:Amazon.CloudFront.Model.TrustedSignerDoesNotExistException"> One or more of your trusted signers do not exist. </exception> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontClient.BeginUpdateDistribution(Amazon.CloudFront.Model.UpdateDistributionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDistribution operation. </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. </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. </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. </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="T:Amazon.CloudFront.AmazonCloudFrontCookieSigner"> <summary> This utility class provides methods for creating signed cookies for Amazon CloudFront distributions using canned or custom policies. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCannedPolicy(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.IO.FileSystemInfo,System.String,System.String,System.DateTime)"> <summary> Returns signed cookies that grants universal access to private content until a given date. </summary> <param name="protocol">The protocol used to access content using signed cookies.</param> <param name="distributionDomain">The domain name of the distribution.</param> <param name="resourcePath">The path for the resource.</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="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <returns>The signed cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCannedPolicy(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.IO.TextReader,System.String,System.String,System.DateTime)"> <summary> Returns signed cookies that grants universal access to private content until a given date. </summary> <param name="protocol">The protocol used to access content using signed cookies.</param> <param name="distributionDomain">The domain name of the distribution.</param> <param name="resourcePath">The path for the resource.</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="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <returns>The signed cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCannedPolicy(System.String,System.String,System.IO.FileSystemInfo,System.DateTime)"> <summary> Generate signed cookies that allows access to a specific distribution and resource path 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 + "/" + path</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="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <returns>The signed cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCannedPolicy(System.String,System.String,System.IO.TextReader,System.DateTime)"> <summary> Generate signed cookies that allows access to a specific distribution and resource path 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 + "/" + path</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="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <returns>The signed cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCustomPolicy(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.IO.FileSystemInfo,System.String,System.String,System.DateTime,System.DateTime,System.String)"> <summary> Returns signed cookies that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="protocol">The protocol used to access content using signed cookies.</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="resourcePath">The path for the resource.</param> <param name="keyPairId">The key pair id corresponding to the private key file given.</param> <param name="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <param name="activeFrom">The date from which content can be accessed using the generated cookies.</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 cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCustomPolicy(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.IO.TextReader,System.String,System.String,System.DateTime,System.DateTime,System.String)"> <summary> Returns signed cookies that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="protocol">The protocol used to access content using signed cookies.</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="resourcePath">The path for the resource.</param> <param name="keyPairId">The key pair id corresponding to the private key file given.</param> <param name="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <param name="activeFrom">The date from which content can be accessed using the generated cookies.</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 cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCustomPolicy(System.String,System.IO.TextReader,System.String,System.DateTime,System.DateTime,System.String)"> <summary> Returns signed cookies that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="resourceUrlOrPath"> The URL or path for resource within a distribution. </param> <param name="privateKey">Your 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="expiresOn">The expiration date till which content can be accessed using the generated cookies.</param> <param name="activeFrom">The date from which content can be accessed using the generated cookies.</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 cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GetCookiesForCustomPolicy(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.IO.TextReader,System.String,System.String,System.DateTime,System.String)"> <summary> Returns signed cookies that provides tailored access to private content based on an access time window and an ip range. </summary> <param name="protocol">The protocol used to access content using signed cookies.</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="resourcePath">The path for the resource.</param> <param name="keyPairId">The key pair id corresponding to the private key file given.</param> <param name="expiresOn">The expiration date till which content can be accessed using the generated cookies.</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 cookies.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontCookieSigner.GenerateResourcePath(Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols,System.String,System.String)"> <summary> Returns the resource path for the given distribution, object, and protocol. </summary> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontCookieSigner.Protocols"> <summary> The supported protocols for accessing restricted content using signed cookies. You may combine the enums for specifying multiple protocols. </summary> </member> <member name="T:Amazon.CloudFront.SignedCookies"> <summary> Contains common cookies used by Amazon CloudFront. </summary> </member> <member name="P:Amazon.CloudFront.SignedCookies.KeyPairId"> <summary> The active CloudFront key pair Id for the key pair (Trusted Signer) that you are using to generate the signature. <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-trusted-signers.html"> Specifying the AWS Accounts That Can Create Signed URLs and Signed Cookies (Trusted Signers)</a> in the <i>Amazon CloudFront User Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudFront.SignedCookies.Signature"> <summary> The hashed and signed version of the policy. </summary> </member> <member name="T:Amazon.CloudFront.CookiesForCannedPolicy"> <summary> Contains the cookies used to access restricted content from CloudFront using a canned policy. </summary> </member> <member name="P:Amazon.CloudFront.CookiesForCannedPolicy.Expires"> <summary> Date and time in Unix time format (in seconds) and Coordinated Universal Time (UTC). </summary> </member> <member name="T:Amazon.CloudFront.CookiesForCustomPolicy"> <summary> Contains the cookies used to access restricted content from CloudFront using a custom policy. </summary> </member> <member name="P:Amazon.CloudFront.CookiesForCustomPolicy.Policy"> <summary> Base64 encoded version of the custom policy. </summary> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontUrlSigner"> <summary> This utility class provides methods for creating signed URLs for Amazon CloudFront distributions using canned or custom policies. </summary> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCannedSignedURL(Amazon.CloudFront.AmazonCloudFrontUrlSigner.Protocol,System.String,System.IO.FileSystemInfo,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="resourcePath">The path for the resource, 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="expiresOn">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.TextReader,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="resourcePath">The path for the resource, 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="expiresOn">The expiration date of the signed URL</param> <returns>The signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.GetCannedSignedURL(System.String,System.IO.TextReader,System.String,System.DateTime)"> <summary> Returns a signed URL that grants universal access to private content until a given date. </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 + "/" + path</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="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="expiresOn">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.FileSystemInfo,System.String,System.String,System.DateTime,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="resourcePath">The path for the resource, 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="expiresOn">The expiration date of the signed URL</param> <param name="activeFrom">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.TextReader,System.String,System.String,System.DateTime,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="resourcePath">The path for the resource, 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="expiresOn">The expiration date of the signed URL</param> <param name="activeFrom">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.TextReader,System.String,System.String,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="resourcePath">The path for the resource, 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="expiresOn">The expiration 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(System.String,System.IO.TextReader,System.String,System.DateTime,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="resourceUrlOrPath"> The URL or path that uniquely identifies a resource within a distribution. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + path</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="privateKey">Your 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="expiresOn">The expiration date of the signed URL</param> <param name="activeFrom">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 resource path 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 + "/" + path</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 resource path as specified in the policy document.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.SignUrl(System.String,System.String,System.IO.TextReader,System.String)"> <summary> Generate a signed URL that allows access to distribution and resource path 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 + "/" + path</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 resource path 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 + "/" + path</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="expiresOn">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.TextReader,System.DateTime)"> <summary> Generate a signed URL that allows access to a specific distribution and resource path 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 + "/" + path</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="expiresOn">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.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 + "/" + path</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="expiresOn">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="activeFrom">An optional UTC time and date when the signed URL will become active. A value of DateTime.MinValue (the default value of DateTime) is ignored. </param> <returns>A policy document describing the access permission to apply when generating a signed URL.</returns> </member> <member name="M:Amazon.CloudFront.AmazonCloudFrontUrlSigner.BuildPolicyForSignedUrl(System.String,System.DateTime,System.String)"> <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 resource path will be accessible in a signed URL. For standard distributions the resource URL will be <tt>"http://" + distributionName + "/" + path</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 resource 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 resource path associated with the certificate keypair used to generate the signed URL. </param> <param name="expiresOn">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> <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.GeoRestrictionType"> <summary> Constants used for properties of type GeoRestrictionType. </summary> </member> <member name="F:Amazon.CloudFront.GeoRestrictionType.Blacklist"> <summary> Constant Blacklist for GeoRestrictionType </summary> </member> <member name="F:Amazon.CloudFront.GeoRestrictionType.None"> <summary> Constant None for GeoRestrictionType </summary> </member> <member name="F:Amazon.CloudFront.GeoRestrictionType.Whitelist"> <summary> Constant Whitelist for GeoRestrictionType </summary> </member> <member name="M:Amazon.CloudFront.GeoRestrictionType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.GeoRestrictionType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.ItemSelection"> <summary> Constants used for properties of type ItemSelection. </summary> </member> <member name="F:Amazon.CloudFront.ItemSelection.All"> <summary> Constant All for ItemSelection </summary> </member> <member name="F:Amazon.CloudFront.ItemSelection.None"> <summary> Constant None for ItemSelection </summary> </member> <member name="F:Amazon.CloudFront.ItemSelection.Whitelist"> <summary> Constant Whitelist for ItemSelection </summary> </member> <member name="M:Amazon.CloudFront.ItemSelection.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.ItemSelection.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.Method"> <summary> Constants used for properties of type Method. </summary> </member> <member name="F:Amazon.CloudFront.Method.DELETE"> <summary> Constant DELETE for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.GET"> <summary> Constant GET for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.HEAD"> <summary> Constant HEAD for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.OPTIONS"> <summary> Constant OPTIONS for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.PATCH"> <summary> Constant PATCH for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.POST"> <summary> Constant POST for Method </summary> </member> <member name="F:Amazon.CloudFront.Method.PUT"> <summary> Constant PUT for Method </summary> </member> <member name="M:Amazon.CloudFront.Method.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.Method.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.MinimumProtocolVersion"> <summary> Constants used for properties of type MinimumProtocolVersion. </summary> </member> <member name="F:Amazon.CloudFront.MinimumProtocolVersion.SSLv3"> <summary> Constant SSLv3 for MinimumProtocolVersion </summary> </member> <member name="F:Amazon.CloudFront.MinimumProtocolVersion.TLSv1"> <summary> Constant TLSv1 for MinimumProtocolVersion </summary> </member> <member name="M:Amazon.CloudFront.MinimumProtocolVersion.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.MinimumProtocolVersion.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.OriginProtocolPolicy"> <summary> Constants used for properties of type OriginProtocolPolicy. </summary> </member> <member name="F:Amazon.CloudFront.OriginProtocolPolicy.HttpOnly"> <summary> Constant HttpOnly for OriginProtocolPolicy </summary> </member> <member name="F:Amazon.CloudFront.OriginProtocolPolicy.MatchViewer"> <summary> Constant MatchViewer for OriginProtocolPolicy </summary> </member> <member name="M:Amazon.CloudFront.OriginProtocolPolicy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.OriginProtocolPolicy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.PriceClass"> <summary> Constants used for properties of type PriceClass. </summary> </member> <member name="F:Amazon.CloudFront.PriceClass.PriceClass_100"> <summary> Constant PriceClass_100 for PriceClass </summary> </member> <member name="F:Amazon.CloudFront.PriceClass.PriceClass_200"> <summary> Constant PriceClass_200 for PriceClass </summary> </member> <member name="F:Amazon.CloudFront.PriceClass.PriceClass_All"> <summary> Constant PriceClass_All for PriceClass </summary> </member> <member name="M:Amazon.CloudFront.PriceClass.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.PriceClass.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.SSLSupportMethod"> <summary> Constants used for properties of type SSLSupportMethod. </summary> </member> <member name="F:Amazon.CloudFront.SSLSupportMethod.SniOnly"> <summary> Constant SniOnly for SSLSupportMethod </summary> </member> <member name="F:Amazon.CloudFront.SSLSupportMethod.Vip"> <summary> Constant Vip for SSLSupportMethod </summary> </member> <member name="M:Amazon.CloudFront.SSLSupportMethod.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.SSLSupportMethod.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudFront.ViewerProtocolPolicy"> <summary> Constants used for properties of type ViewerProtocolPolicy. </summary> </member> <member name="F:Amazon.CloudFront.ViewerProtocolPolicy.AllowAll"> <summary> Constant AllowAll for ViewerProtocolPolicy </summary> </member> <member name="F:Amazon.CloudFront.ViewerProtocolPolicy.HttpsOnly"> <summary> Constant HttpsOnly for ViewerProtocolPolicy </summary> </member> <member name="F:Amazon.CloudFront.ViewerProtocolPolicy.RedirectToHttps"> <summary> Constant RedirectToHttps for ViewerProtocolPolicy </summary> </member> <member name="M:Amazon.CloudFront.ViewerProtocolPolicy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudFront.ViewerProtocolPolicy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.ActiveTrustedSigners.#ctor(System.Collections.Generic.List{Amazon.CloudFront.Model.Signer})"> <summary> Instantiates ActiveTrustedSigners with the parameterized properties </summary> <param name="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.</param> </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="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 three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, 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="P:Amazon.CloudFront.Model.AllowedMethods.CachedMethods"> <summary> Gets and sets the property CachedMethods. </summary> </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), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests). </summary> </member> <member name="T:Amazon.CloudFront.AmazonCloudFrontRequest"> <summary> Base class for CloudFront operation 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="P:Amazon.CloudFront.Model.CacheBehavior.AllowedMethods"> <summary> Gets and sets the property AllowedMethods. </summary> </member> <member name="P:Amazon.CloudFront.Model.CacheBehavior.DefaultTTL"> <summary> Gets and sets the property DefaultTTL. If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </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.MaxTTL"> <summary> Gets and sets the property MaxTTL. The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </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="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.CachedMethods"> <summary> A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly. </summary> </member> <member name="P:Amazon.CloudFront.Model.CachedMethods.Items"> <summary> Gets and sets the property Items. A complex type that contains the HTTP methods that you want CloudFront to cache responses to. </summary> </member> <member name="P:Amazon.CloudFront.Model.CachedMethods.Quantity"> <summary> Gets and sets the property Quantity. The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests). </summary> </member> <member name="T:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentity"> <summary> CloudFront origin access identity. </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig.#ctor(System.String)"> <summary> Instantiates CloudFrontOriginAccessIdentityConfig with the parameterized properties </summary> <param name="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.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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="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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityRequest.#ctor(Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Instantiates CreateCloudFrontOriginAccessIdentityRequest with the parameterized properties </summary> <param name="cloudFrontOriginAccessIdentityConfig">The origin access identity's configuration information.</param> </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> Configuration for accessing Amazon CreateCloudFrontOriginAccessIdentity service </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </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="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.CreateDistributionRequest"> <summary> Container for the parameters to the CreateDistribution operation. Create a new distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateDistributionRequest.#ctor(Amazon.CloudFront.Model.DistributionConfig)"> <summary> Instantiates CreateDistributionRequest with the parameterized properties </summary> <param name="distributionConfig">The distribution's configuration information.</param> </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> Configuration for accessing Amazon CreateDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.CreateInvalidationRequest"> <summary> Container for the parameters to the CreateInvalidation operation. Create a new invalidation. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateInvalidationRequest.#ctor(System.String,Amazon.CloudFront.Model.InvalidationBatch)"> <summary> Instantiates CreateInvalidationRequest with the parameterized properties </summary> <param name="distributionId">The distribution's id.</param> <param name="invalidationBatch">The batch information for the invalidation.</param> </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> Configuration for accessing Amazon CreateInvalidation service </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateInvalidationResult"> <summary> The returned result of the corresponding request. </summary> </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="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.CreateStreamingDistributionRequest"> <summary> Container for the parameters to the CreateStreamingDistribution operation. Create a new streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.CreateStreamingDistributionRequest.#ctor(Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Instantiates CreateStreamingDistributionRequest with the parameterized properties </summary> <param name="streamingDistributionConfig">The streaming distribution's configuration information.</param> </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> Configuration for accessing Amazon CreateStreamingDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.CreateStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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="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="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="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="P:Amazon.CloudFront.Model.DefaultCacheBehavior.AllowedMethods"> <summary> Gets and sets the property AllowedMethods. </summary> </member> <member name="P:Amazon.CloudFront.Model.DefaultCacheBehavior.DefaultTTL"> <summary> Gets and sets the property DefaultTTL. If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </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.MaxTTL"> <summary> Gets and sets the property MaxTTL. The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years). </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteCloudFrontOriginAccessIdentityRequest.#ctor(System.String,System.String)"> <summary> Instantiates DeleteCloudFrontOriginAccessIdentityRequest with the parameterized properties </summary> <param name="id">The origin access identity's id.</param> <param name="ifMatch">The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.</param> </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.DeleteDistributionRequest"> <summary> Container for the parameters to the DeleteDistribution operation. Delete a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteDistributionRequest.#ctor(System.String,System.String)"> <summary> Instantiates DeleteDistributionRequest with the parameterized properties </summary> <param name="id">The distribution id.</param> <param name="ifMatch">The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.</param> </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.DeleteStreamingDistributionRequest"> <summary> Container for the parameters to the DeleteStreamingDistribution operation. Delete a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.DeleteStreamingDistributionRequest.#ctor(System.String,System.String)"> <summary> Instantiates DeleteStreamingDistributionRequest with the parameterized properties </summary> <param name="id">The distribution id.</param> <param name="ifMatch">The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.</param> </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.Distribution"> <summary> A distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.Distribution.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.Distribution.#ctor(System.String,System.String,System.String)"> <summary> Instantiates Distribution with the parameterized properties </summary> <param name="id">The identifier for the distribution. For example: EDFDVBD632BHDS5.</param> <param name="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.</param> <param name="domainName">The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.DistributionConfig.#ctor(System.String,System.Boolean)"> <summary> Instantiates DistributionConfig with the parameterized properties </summary> <param name="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.</param> <param name="enabled">Whether the distribution is enabled to accept end user requests for content.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GeoRestriction.#ctor(Amazon.CloudFront.GeoRestrictionType)"> <summary> Instantiates GeoRestriction with the parameterized properties </summary> <param name="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.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigRequest.#ctor(System.String)"> <summary> Instantiates GetCloudFrontOriginAccessIdentityConfigRequest with the parameterized properties </summary> <param name="id">The identity's id.</param> </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> Configuration for accessing Amazon GetCloudFrontOriginAccessIdentityConfig service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityConfigResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityRequest.#ctor(System.String)"> <summary> Instantiates GetCloudFrontOriginAccessIdentityRequest with the parameterized properties </summary> <param name="id">The identity's id.</param> </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> Configuration for accessing Amazon GetCloudFrontOriginAccessIdentity service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionConfigRequest.#ctor(System.String)"> <summary> Instantiates GetDistributionConfigRequest with the parameterized properties </summary> <param name="id">The distribution's id.</param> </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> Configuration for accessing Amazon GetDistributionConfig service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionConfigResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetDistributionRequest.#ctor(System.String)"> <summary> Instantiates GetDistributionRequest with the parameterized properties </summary> <param name="id">The distribution's id.</param> </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> Configuration for accessing Amazon GetDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetInvalidationRequest.#ctor(System.String,System.String)"> <summary> Instantiates GetInvalidationRequest with the parameterized properties </summary> <param name="distributionId">The distribution's id.</param> <param name="id">The invalidation's id.</param> </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> Configuration for accessing Amazon GetInvalidation service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetInvalidationResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="P:Amazon.CloudFront.Model.GetInvalidationResult.Invalidation"> <summary> Gets and sets the property Invalidation. The invalidation's information. </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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionConfigRequest.#ctor(System.String)"> <summary> Instantiates GetStreamingDistributionConfigRequest with the parameterized properties </summary> <param name="id">The streaming distribution's id.</param> </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> Configuration for accessing Amazon GetStreamingDistributionConfig service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionConfigResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.GetStreamingDistributionRequest.#ctor(System.String)"> <summary> Instantiates GetStreamingDistributionRequest with the parameterized properties </summary> <param name="id">The streaming distribution's id.</param> </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> Configuration for accessing Amazon GetStreamingDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.GetStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.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="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.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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidationBatch.#ctor(Amazon.CloudFront.Model.Paths,System.String)"> <summary> Instantiates InvalidationBatch with the parameterized properties </summary> <param name="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.</param> <param name="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.</param> </member> <member name="M:Amazon.CloudFront.Model.InvalidationBatch.#ctor(System.String)"> <summary> Instantiates InvalidationBatch with the parameterized properties </summary> <param name="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.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.InvalidMinimumProtocolVersionException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidMinimumProtocolVersionException.#ctor(System.String)"> <summary> Constructs a new InvalidMinimumProtocolVersionException 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.InvalidProtocolSettingsException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidProtocolSettingsException.#ctor(System.String)"> <summary> Constructs a new InvalidProtocolSettingsException 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.InvalidTTLOrderException"> <summary> CloudFront exception </summary> </member> <member name="M:Amazon.CloudFront.Model.InvalidTTLOrderException.#ctor(System.String)"> <summary> Constructs a new InvalidTTLOrderException 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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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> Configuration for accessing Amazon ListCloudFrontOriginAccessIdentities service </summary> </member> <member name="T:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListCloudFrontOriginAccessIdentitiesResult.CloudFrontOriginAccessIdentityList"> <summary> Gets and sets the property CloudFrontOriginAccessIdentityList. The CloudFrontOriginAccessIdentityList type. </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.ListDistributionsRequest"> <summary> Container for the parameters to the ListDistributions operation. List distributions. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListDistributionsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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> Configuration for accessing Amazon ListDistributions service </summary> </member> <member name="T:Amazon.CloudFront.Model.ListDistributionsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListDistributionsResult.DistributionList"> <summary> Gets and sets the property DistributionList. The DistributionList type. </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.ListInvalidationsRequest"> <summary> Container for the parameters to the ListInvalidations operation. List invalidation batches. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.ListInvalidationsRequest.#ctor(System.String)"> <summary> Instantiates ListInvalidationsRequest with the parameterized properties </summary> <param name="distributionId">The distribution's id.</param> </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> Configuration for accessing Amazon ListInvalidations service </summary> </member> <member name="T:Amazon.CloudFront.Model.ListInvalidationsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListInvalidationsResult.InvalidationList"> <summary> Gets and sets the property InvalidationList. Information about invalidation batches. </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.ListStreamingDistributionsRequest"> <summary> Container for the parameters to the ListStreamingDistributions operation. List streaming distributions. </summary> </member> <member name="M:Amazon.CloudFront.Model.ListStreamingDistributionsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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> Configuration for accessing Amazon ListStreamingDistributions service </summary> </member> <member name="T:Amazon.CloudFront.Model.ListStreamingDistributionsResult"> <summary> The returned result of the corresponding request. </summary> </member> <member name="P:Amazon.CloudFront.Model.ListStreamingDistributionsResult.StreamingDistributionList"> <summary> Gets and sets the property StreamingDistributionList. The StreamingDistributionList type. </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.LoggingConfig"> <summary> A complex type that controls whether access logs are written for the distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.LoggingConfig.#ctor(System.String,System.String)"> <summary> Instantiates LoggingConfig with the parameterized properties </summary> <param name="bucket">The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.</param> <param name="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.</param> </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="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.OriginPath"> <summary> Gets and sets the property OriginPath. An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName. </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="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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.Restrictions.#ctor(Amazon.CloudFront.Model.GeoRestriction)"> <summary> Instantiates Restrictions with the parameterized properties </summary> <param name="geoRestriction">Sets the Restrictions GeoRestriction property</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.S3Origin.#ctor(System.String)"> <summary> Instantiates S3Origin with the parameterized properties </summary> <param name="domainName">The DNS name of the S3 origin.</param> </member> <member name="M:Amazon.CloudFront.Model.S3Origin.#ctor(System.String,System.String)"> <summary> Instantiates S3Origin with the parameterized properties </summary> <param name="domainName">The DNS name of the S3 origin.</param> <param name="originAccessIdentity">Your S3 origin's origin access identity.</param> </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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </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="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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.TrustedSigners.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates TrustedSigners with the parameterized properties </summary> <param name="items">Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.</param> </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.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityRequest.#ctor(System.String,System.String,Amazon.CloudFront.Model.CloudFrontOriginAccessIdentityConfig)"> <summary> Instantiates UpdateCloudFrontOriginAccessIdentityRequest with the parameterized properties </summary> <param name="id">The identity's id.</param> <param name="ifMatch">The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.</param> <param name="cloudFrontOriginAccessIdentityConfig">The identity's configuration information.</param> </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> Configuration for accessing Amazon UpdateCloudFrontOriginAccessIdentity service </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateCloudFrontOriginAccessIdentityResult"> <summary> The returned result of the corresponding request. </summary> </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="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.UpdateDistributionRequest"> <summary> Container for the parameters to the UpdateDistribution operation. Update a distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateDistributionRequest.#ctor(System.String,System.String,Amazon.CloudFront.Model.DistributionConfig)"> <summary> Instantiates UpdateDistributionRequest with the parameterized properties </summary> <param name="id">The distribution's id.</param> <param name="ifMatch">The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.</param> <param name="distributionConfig">The distribution's configuration information.</param> </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> Configuration for accessing Amazon UpdateDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.UpdateStreamingDistributionRequest"> <summary> Container for the parameters to the UpdateStreamingDistribution operation. Update a streaming distribution. </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudFront.Model.UpdateStreamingDistributionRequest.#ctor(System.String,System.String,Amazon.CloudFront.Model.StreamingDistributionConfig)"> <summary> Instantiates UpdateStreamingDistributionRequest with the parameterized properties </summary> <param name="id">The streaming distribution's id.</param> <param name="ifMatch">The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.</param> <param name="streamingDistributionConfig">The streaming distribution's configuration information.</param> </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> Configuration for accessing Amazon UpdateStreamingDistribution service </summary> </member> <member name="T:Amazon.CloudFront.Model.UpdateStreamingDistributionResult"> <summary> The returned result of the corresponding request. </summary> </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="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.ViewerCertificate"> <summary> A complex type that contains information about viewer certificates for this distribution. </summary> </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.MinimumProtocolVersion"> <summary> Gets and sets the property MinimumProtocolVersion. Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion. </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.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.CachedMethodsUnmarshaller"> <summary> Response Unmarshaller for CachedMethods 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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.ViewerCertificateUnmarshaller"> <summary> Response Unmarshaller for ViewerCertificate Object </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.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.CloudSearch.AmazonCloudSearchClient"> <summary> Implementation for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region" target="_blank">Regions and Endpoints</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearch.IAmazonCloudSearch"> <summary> Interface for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region" target="_blank">Regions and Endpoints</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters service method.</param> <returns>The response from the BuildSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginBuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndBuildSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BuildSuggesters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBuildSuggesters.</param> <returns>Returns a BuildSuggestersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginCreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme service method.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineAnalysisScheme operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineAnalysisScheme.</param> <returns>Returns a DefineAnalysisSchemeResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression service method.</param> <returns>The response from the DefineExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineExpression operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineExpression.</param> <returns>Returns a DefineExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester service method.</param> <returns>The response from the DefineSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineSuggester operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineSuggester.</param> <returns>Returns a DefineSuggesterResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme service method.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteAnalysisScheme(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAnalysisScheme operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAnalysisScheme.</param> <returns>Returns a DeleteAnalysisSchemeResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression service method.</param> <returns>The response from the DeleteExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteExpression operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteExpression.</param> <returns>Returns a DeleteExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester service method.</param> <returns>The response from the DeleteSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteSuggester(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSuggester operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSuggester.</param> <returns>Returns a DeleteSuggesterResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeAnalysisSchemes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAnalysisSchemes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAnalysisSchemes.</param> <returns>Returns a DescribeAnalysisSchemesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions service method.</param> <returns>The response from the DescribeExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExpressions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExpressions.</param> <returns>Returns a DescribeExpressionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters service method.</param> <returns>The response from the DescribeScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeScalingParameters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingParameters.</param> <returns>Returns a DescribeScalingParametersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters service method.</param> <returns>The response from the DescribeSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginDescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeSuggesters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSuggesters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSuggesters.</param> <returns>Returns a DescribeSuggestersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginIndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.ListDomainNames"> <summary> Lists all search domains owned by an account. </summary> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> Lists all search domains owned by an account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames service method.</param> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndListDomainNames(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDomainNames operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDomainNames.</param> <returns>Returns a ListDomainNamesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginUpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters service method.</param> <returns>The response from the UpdateScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginUpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateScalingParameters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateScalingParameters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateScalingParameters.</param> <returns>Returns a UpdateScalingParametersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.IAmazonCloudSearch.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials and an AmazonCloudSearchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearch.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest)"> <summary> Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters service method.</param> <returns>The response from the BuildSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginBuildSuggesters(Amazon.CloudSearch.Model.BuildSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BuildSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the BuildSuggesters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBuildSuggesters.</param> <returns>Returns a BuildSuggestersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest)"> <summary> Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginCreateDomain(Amazon.CloudSearch.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest)"> <summary> Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme service method.</param> <returns>The response from the DefineAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineAnalysisScheme(Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineAnalysisScheme operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineAnalysisScheme.</param> <returns>Returns a DefineAnalysisSchemeResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest)"> <summary> Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression service method.</param> <returns>The response from the DefineExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineExpression(Amazon.CloudSearch.Model.DefineExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineExpression.</param> <returns>Returns a DefineExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest)"> <summary> Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineIndexField(Amazon.CloudSearch.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest)"> <summary> Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester service method.</param> <returns>The response from the DefineSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDefineSuggester(Amazon.CloudSearch.Model.DefineSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineSuggester operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineSuggester.</param> <returns>Returns a DefineSuggesterResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest)"> <summary> Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme service method.</param> <returns>The response from the DeleteAnalysisScheme service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteAnalysisScheme(Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAnalysisScheme operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAnalysisScheme operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAnalysisScheme.</param> <returns>Returns a DeleteAnalysisSchemeResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteDomain(Amazon.CloudSearch.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest)"> <summary> Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression service method.</param> <returns>The response from the DeleteExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteExpression(Amazon.CloudSearch.Model.DeleteExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteExpression.</param> <returns>Returns a DeleteExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteIndexField(Amazon.CloudSearch.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest)"> <summary> Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester service method.</param> <returns>The response from the DeleteSuggester service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDeleteSuggester(Amazon.CloudSearch.Model.DeleteSuggesterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSuggester operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSuggester operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSuggester.</param> <returns>Returns a DeleteSuggesterResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest)"> <summary> Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes service method.</param> <returns>The response from the DescribeAnalysisSchemes service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeAnalysisSchemes(Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAnalysisSchemes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAnalysisSchemes operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAnalysisSchemes.</param> <returns>Returns a DescribeAnalysisSchemesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeAvailabilityOptions(Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeDomains(Amazon.CloudSearch.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest)"> <summary> Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions service method.</param> <returns>The response from the DescribeExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeExpressions(Amazon.CloudSearch.Model.DescribeExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExpressions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExpressions.</param> <returns>Returns a DescribeExpressionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeIndexFields(Amazon.CloudSearch.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest)"> <summary> Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters service method.</param> <returns>The response from the DescribeScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeScalingParameters(Amazon.CloudSearch.Model.DescribeScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeScalingParameters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeScalingParameters.</param> <returns>Returns a DescribeScalingParametersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.DescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest)"> <summary> Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters service method.</param> <returns>The response from the DescribeSuggesters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginDescribeSuggesters(Amazon.CloudSearch.Model.DescribeSuggestersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSuggesters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSuggesters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSuggesters.</param> <returns>Returns a DescribeSuggestersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginIndexDocuments(Amazon.CloudSearch.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames"> <summary> Lists all search domains owned by an account. </summary> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.ListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest)"> <summary> Lists all search domains owned by an account. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames service method.</param> <returns>The response from the ListDomainNames service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginListDomainNames(Amazon.CloudSearch.Model.ListDomainNamesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDomainNames operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDomainNames operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDomainNames.</param> <returns>Returns a ListDomainNamesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateAvailabilityOptions(Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest)"> <summary> Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters service method.</param> <returns>The response from the UpdateScalingParameters service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateScalingParameters(Amazon.CloudSearch.Model.UpdateScalingParametersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateScalingParameters operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateScalingParameters operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateScalingParameters.</param> <returns>Returns a UpdateScalingParametersResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch.AmazonCloudSearchClient.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearchConfig"> <summary> Configuration for accessing Amazon CloudSearch 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.AlgorithmicStemming"> <summary> Constants used for properties of type AlgorithmicStemming. </summary> </member> <member name="F:Amazon.CloudSearch.AlgorithmicStemming.Full"> <summary> Constant Full for AlgorithmicStemming </summary> </member> <member name="F:Amazon.CloudSearch.AlgorithmicStemming.Light"> <summary> Constant Light for AlgorithmicStemming </summary> </member> <member name="F:Amazon.CloudSearch.AlgorithmicStemming.Minimal"> <summary> Constant Minimal for AlgorithmicStemming </summary> </member> <member name="F:Amazon.CloudSearch.AlgorithmicStemming.None"> <summary> Constant None for AlgorithmicStemming </summary> </member> <member name="M:Amazon.CloudSearch.AlgorithmicStemming.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.AlgorithmicStemming.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.AnalysisSchemeLanguage"> <summary> Constants used for properties of type AnalysisSchemeLanguage. </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ar"> <summary> Constant Ar for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Bg"> <summary> Constant Bg for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ca"> <summary> Constant Ca for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Cs"> <summary> Constant Cs for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Da"> <summary> Constant Da for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.De"> <summary> Constant De for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.El"> <summary> Constant El for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.En"> <summary> Constant En for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Es"> <summary> Constant Es for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Eu"> <summary> Constant Eu for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Fa"> <summary> Constant Fa for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Fi"> <summary> Constant Fi for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Fr"> <summary> Constant Fr for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ga"> <summary> Constant Ga for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Gl"> <summary> Constant Gl for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.He"> <summary> Constant He for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Hi"> <summary> Constant Hi for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Hu"> <summary> Constant Hu for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Hy"> <summary> Constant Hy for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Id"> <summary> Constant Id for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.It"> <summary> Constant It for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ja"> <summary> Constant Ja for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ko"> <summary> Constant Ko for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Lv"> <summary> Constant Lv for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Mul"> <summary> Constant Mul for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Nl"> <summary> Constant Nl for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.No"> <summary> Constant No for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Pt"> <summary> Constant Pt for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ro"> <summary> Constant Ro for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Ru"> <summary> Constant Ru for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Sv"> <summary> Constant Sv for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Th"> <summary> Constant Th for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.Tr"> <summary> Constant Tr for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.ZhHans"> <summary> Constant ZhHans for AnalysisSchemeLanguage </summary> </member> <member name="F:Amazon.CloudSearch.AnalysisSchemeLanguage.ZhHant"> <summary> Constant ZhHant for AnalysisSchemeLanguage </summary> </member> <member name="M:Amazon.CloudSearch.AnalysisSchemeLanguage.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.AnalysisSchemeLanguage.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.IndexFieldType"> <summary> Constants used for properties of type IndexFieldType. </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Date"> <summary> Constant Date for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.DateArray"> <summary> Constant DateArray for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Double"> <summary> Constant Double for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.DoubleArray"> <summary> Constant DoubleArray for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Int"> <summary> Constant Int for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.IntArray"> <summary> Constant IntArray for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Latlon"> <summary> Constant Latlon for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Literal"> <summary> Constant Literal for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.LiteralArray"> <summary> Constant LiteralArray for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.Text"> <summary> Constant Text for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch.IndexFieldType.TextArray"> <summary> Constant TextArray for IndexFieldType </summary> </member> <member name="M:Amazon.CloudSearch.IndexFieldType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.IndexFieldType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.OptionState"> <summary> Constants used for properties of type OptionState. </summary> </member> <member name="F:Amazon.CloudSearch.OptionState.Active"> <summary> Constant Active for OptionState </summary> </member> <member name="F:Amazon.CloudSearch.OptionState.FailedToValidate"> <summary> Constant FailedToValidate for OptionState </summary> </member> <member name="F:Amazon.CloudSearch.OptionState.Processing"> <summary> Constant Processing for OptionState </summary> </member> <member name="F:Amazon.CloudSearch.OptionState.RequiresIndexDocuments"> <summary> Constant RequiresIndexDocuments for OptionState </summary> </member> <member name="M:Amazon.CloudSearch.OptionState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.OptionState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.PartitionInstanceType"> <summary> Constants used for properties of type PartitionInstanceType. </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM1Large"> <summary> Constant SearchM1Large for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM1Small"> <summary> Constant SearchM1Small for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM22xlarge"> <summary> Constant SearchM22xlarge for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM2Xlarge"> <summary> Constant SearchM2Xlarge for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM32xlarge"> <summary> Constant SearchM32xlarge for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM3Large"> <summary> Constant SearchM3Large for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM3Medium"> <summary> Constant SearchM3Medium for PartitionInstanceType </summary> </member> <member name="F:Amazon.CloudSearch.PartitionInstanceType.SearchM3Xlarge"> <summary> Constant SearchM3Xlarge for PartitionInstanceType </summary> </member> <member name="M:Amazon.CloudSearch.PartitionInstanceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.PartitionInstanceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.SuggesterFuzzyMatching"> <summary> Constants used for properties of type SuggesterFuzzyMatching. </summary> </member> <member name="F:Amazon.CloudSearch.SuggesterFuzzyMatching.High"> <summary> Constant High for SuggesterFuzzyMatching </summary> </member> <member name="F:Amazon.CloudSearch.SuggesterFuzzyMatching.Low"> <summary> Constant Low for SuggesterFuzzyMatching </summary> </member> <member name="F:Amazon.CloudSearch.SuggesterFuzzyMatching.None"> <summary> Constant None for SuggesterFuzzyMatching </summary> </member> <member name="M:Amazon.CloudSearch.SuggesterFuzzyMatching.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch.SuggesterFuzzyMatching.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch.Model.AccessPoliciesStatus"> <summary> The configured access rules for the domain's document and search endpoints, and the current status of those rules. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AccessPoliciesStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AccessPoliciesStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.AmazonCloudSearchRequest"> <summary> Base class for CloudSearch operation requests. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AnalysisOptions"> <summary> Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.AlgorithmicStemming"> <summary> Gets and sets the property AlgorithmicStemming. <para> The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings" target="_blank">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.JapaneseTokenizationDictionary"> <summary> Gets and sets the property JapaneseTokenizationDictionary. <para> A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.StemmingDictionary"> <summary> Gets and sets the property StemmingDictionary. <para> A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{"term1": "stem1", "term2": "stem2", "term3": "stem3"}</code>. 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.Stopwords"> <summary> Gets and sets the property Stopwords. <para> A JSON array of terms to ignore during indexing and searching. For example, <code>["a", "an", "the", "of"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisOptions.Synonyms"> <summary> Gets and sets the property Synonyms. <para> 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. For more information about specifying synonyms, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.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: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisOptions"> <summary> Gets and sets the property AnalysisOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisSchemeLanguage"> <summary> Gets and sets the property AnalysisSchemeLanguage. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisScheme.AnalysisSchemeName"> <summary> Gets and sets the property AnalysisSchemeName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AnalysisSchemeStatus"> <summary> The status and configuration of an <code>AnalysisScheme</code>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisSchemeStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AnalysisSchemeStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.AvailabilityOptionsStatus"> <summary> The status and configuration of the domain's availability options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.Options"> <summary> Gets and sets the property Options. <para> The availability options configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.AvailabilityOptionsStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.BaseException"> <summary> CloudSearch 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. Indexes the search suggestions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.BuildSuggestersResponse"> <summary> Configuration for accessing Amazon BuildSuggesters service </summary> </member> <member name="T:Amazon.CloudSearch.Model.BuildSuggestersResult"> <summary> The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersResult.FieldNames"> <summary> Gets and sets the property FieldNames. </summary> </member> <member name="P:Amazon.CloudSearch.Model.BuildSuggestersResponse.BuildSuggestersResult"> <summary> Gets and sets the BuildSuggestersResult property. Represents the output of a BuildSuggesters operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainRequest"> <summary> Container for the parameters to the CreateDomain operation. Creates a new search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html" target="_blank">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> 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> </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainResponse"> <summary> Configuration for accessing Amazon CreateDomain service </summary> </member> <member name="T:Amazon.CloudSearch.Model.CreateDomainResult"> <summary> The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain. </summary> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainResult.DomainStatus"> <summary> Gets and sets the property DomainStatus. </summary> </member> <member name="P:Amazon.CloudSearch.Model.CreateDomainResponse.CreateDomainResult"> <summary> Gets and sets the CreateDomainResult property. Represents the output of a CreateDomain operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DateArrayOptions"> <summary> Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateArrayOptions.SourceFields"> <summary> Gets and sets the property SourceFields. <para> A list of source fields to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.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 <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DateOptions.SourceField"> <summary> Gets and sets the property SourceField. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest"> <summary> Container for the parameters to the DefineAnalysisScheme operation. Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.AnalysisScheme"> <summary> Gets and sets the property AnalysisScheme. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeResponse"> <summary> Configuration for accessing Amazon DefineAnalysisScheme service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineAnalysisSchemeResult"> <summary> The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeResult.AnalysisScheme"> <summary> Gets and sets the property AnalysisScheme. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineAnalysisSchemeResponse.DefineAnalysisSchemeResult"> <summary> Gets and sets the DefineAnalysisSchemeResult property. Represents the output of a DefineAnalysisScheme operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionRequest"> <summary> Container for the parameters to the DefineExpression operation. Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionRequest.Expression"> <summary> Gets and sets the property Expression. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionResponse"> <summary> Configuration for accessing Amazon DefineExpression service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineExpressionResult"> <summary> The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionResult.Expression"> <summary> Gets and sets the property Expression. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineExpressionResponse.DefineExpressionResult"> <summary> Gets and sets the DefineExpressionResult property. Represents the output of a DefineExpression operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldRequest"> <summary> Container for the parameters to the DefineIndexField operation. Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldRequest.IndexField"> <summary> Gets and sets the property IndexField. <para> The index field and field options you want to configure. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldResponse"> <summary> Configuration for accessing Amazon DefineIndexField service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineIndexFieldResult"> <summary> The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldResult.IndexField"> <summary> Gets and sets the property IndexField. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineIndexFieldResponse.DefineIndexFieldResult"> <summary> Gets and sets the DefineIndexFieldResult property. Represents the output of a DefineIndexField operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterRequest"> <summary> Container for the parameters to the DefineSuggester operation. Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterRequest.Suggester"> <summary> Gets and sets the property Suggester. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterResponse"> <summary> Configuration for accessing Amazon DefineSuggester service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DefineSuggesterResult"> <summary> The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterResult.Suggester"> <summary> Gets and sets the property Suggester. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DefineSuggesterResponse.DefineSuggesterResult"> <summary> Gets and sets the DefineSuggesterResult property. Represents the output of a DefineSuggester operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest"> <summary> Container for the parameters to the DeleteAnalysisScheme operation. Deletes an analysis scheme. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.AnalysisSchemeName"> <summary> Gets and sets the property AnalysisSchemeName. <para> The name of the analysis scheme you want to delete. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResponse"> <summary> Configuration for accessing Amazon DeleteAnalysisScheme service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResult"> <summary> The result of a <code>DeleteAnalysisScheme</code> request. Contains the status of the deleted analysis scheme. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResult.AnalysisScheme"> <summary> Gets and sets the property AnalysisScheme. <para> The status of the analysis scheme being deleted. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteAnalysisSchemeResponse.DeleteAnalysisSchemeResult"> <summary> Gets and sets the DeleteAnalysisSchemeResult property. Represents the output of a DeleteAnalysisScheme operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainRequest"> <summary> Container for the parameters to the DeleteDomain operation. Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to permanently delete. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainResponse"> <summary> Configuration for accessing Amazon DeleteDomain service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteDomainResult"> <summary> The result of a <code>DeleteDomain</code> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainResult.DomainStatus"> <summary> Gets and sets the property DomainStatus. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteDomainResponse.DeleteDomainResult"> <summary> Gets and sets the DeleteDomainResult property. Represents the output of a DeleteDomain operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionRequest"> <summary> Container for the parameters to the DeleteExpression operation. Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionRequest.ExpressionName"> <summary> Gets and sets the property ExpressionName. <para> The name of the <code><a>Expression</a></code> to delete. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionResponse"> <summary> Configuration for accessing Amazon DeleteExpression service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteExpressionResult"> <summary> The result of a <code><a>DeleteExpression</a></code> request. Specifies the expression being deleted. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionResult.Expression"> <summary> Gets and sets the property Expression. <para> The status of the expression being deleted. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteExpressionResponse.DeleteExpressionResult"> <summary> Gets and sets the DeleteExpressionResult property. Represents the output of a DeleteExpression operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldRequest"> <summary> Container for the parameters to the DeleteIndexField operation. Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldRequest.IndexFieldName"> <summary> Gets and sets the property IndexFieldName. <para> The name of the index field your want to remove from the domain's indexing options. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldResponse"> <summary> Configuration for accessing Amazon DeleteIndexField service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteIndexFieldResult"> <summary> The result of a <code><a>DeleteIndexField</a></code> request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldResult.IndexField"> <summary> Gets and sets the property IndexField. <para> The status of the index field being deleted. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteIndexFieldResponse.DeleteIndexFieldResult"> <summary> Gets and sets the DeleteIndexFieldResult property. Represents the output of a DeleteIndexField operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterRequest"> <summary> Container for the parameters to the DeleteSuggester operation. Deletes a suggester. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterRequest.SuggesterName"> <summary> Gets and sets the property SuggesterName. <para> Specifies the name of the suggester you want to delete. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterResponse"> <summary> Configuration for accessing Amazon DeleteSuggester service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DeleteSuggesterResult"> <summary> The result of a <code>DeleteSuggester</code> request. Contains the status of the deleted suggester. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterResult.Suggester"> <summary> Gets and sets the property Suggester. <para> The status of the suggester being deleted. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DeleteSuggesterResponse.DeleteSuggesterResult"> <summary> Gets and sets the DeleteSuggesterResult property. Represents the output of a DeleteSuggester operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest"> <summary> Container for the parameters to the DescribeAnalysisSchemes operation. Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.AnalysisSchemeNames"> <summary> Gets and sets the property AnalysisSchemeNames. <para> The analysis schemes you want to describe. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResponse"> <summary> Configuration for accessing Amazon DescribeAnalysisSchemes service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult"> <summary> The result of a <code>DescribeAnalysisSchemes</code> request. Contains the analysis schemes configured for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResult.AnalysisSchemes"> <summary> Gets and sets the property AnalysisSchemes. <para> The analysis scheme descriptions. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAnalysisSchemesResponse.DescribeAnalysisSchemesResult"> <summary> Gets and sets the DescribeAnalysisSchemesResult property. Represents the output of a DescribeAnalysisSchemes operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest"> <summary> Container for the parameters to the DescribeAvailabilityOptions operation. Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResponse"> <summary> Configuration for accessing Amazon DescribeAvailabilityOptions service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResult"> <summary> The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResult.AvailabilityOptions"> <summary> Gets and sets the property AvailabilityOptions. <para> The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeAvailabilityOptionsResponse.DescribeAvailabilityOptionsResult"> <summary> Gets and sets the DescribeAvailabilityOptionsResult property. Represents the output of a DescribeAvailabilityOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsRequest"> <summary> Container for the parameters to the DescribeDomains operation. Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsRequest.DomainNames"> <summary> Gets and sets the property DomainNames. <para> The names of the domains you want to include in the response. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsResponse"> <summary> Configuration for accessing Amazon DescribeDomains service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeDomainsResult"> <summary> The result of a <code>DescribeDomains</code> request. Contains the status of the domains specified in the request or all domains owned by the account. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsResult.DomainStatusList"> <summary> Gets and sets the property DomainStatusList. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeDomainsResponse.DescribeDomainsResult"> <summary> Gets and sets the DescribeDomainsResult property. Represents the output of a DescribeDomains operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsRequest"> <summary> Container for the parameters to the DescribeExpressions operation. Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsRequest.ExpressionNames"> <summary> Gets and sets the property ExpressionNames. <para> Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsResponse"> <summary> Configuration for accessing Amazon DescribeExpressions service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeExpressionsResult"> <summary> The result of a <code>DescribeExpressions</code> request. Contains the expressions configured for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsResult.Expressions"> <summary> Gets and sets the property Expressions. <para> The expressions configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeExpressionsResponse.DescribeExpressionsResult"> <summary> Gets and sets the DescribeExpressionsResult property. Represents the output of a DescribeExpressions operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest"> <summary> Container for the parameters to the DescribeIndexFields operation. Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsRequest.FieldNames"> <summary> Gets and sets the property FieldNames. <para> A list of the index fields you want to describe. If not specified, information is returned for all configured index fields. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsResponse"> <summary> Configuration for accessing Amazon DescribeIndexFields service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeIndexFieldsResult"> <summary> The result of a <code>DescribeIndexFields</code> request. Contains the index fields configured for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsResult.IndexFields"> <summary> Gets and sets the property IndexFields. <para> The index fields configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeIndexFieldsResponse.DescribeIndexFieldsResult"> <summary> Gets and sets the DescribeIndexFieldsResult property. Represents the output of a DescribeIndexFields operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersRequest"> <summary> Container for the parameters to the DescribeScalingParameters operation. Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersResponse"> <summary> Configuration for accessing Amazon DescribeScalingParameters service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeScalingParametersResult"> <summary> The result of a <code>DescribeScalingParameters</code> request. Contains the scaling parameters configured for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersResult.ScalingParameters"> <summary> Gets and sets the property ScalingParameters. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeScalingParametersResponse.DescribeScalingParametersResult"> <summary> Gets and sets the DescribeScalingParametersResult property. Represents the output of a DescribeScalingParameters operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest"> <summary> Container for the parameters to the DescribeServiceAccessPolicies operation. Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResponse"> <summary> Configuration for accessing Amazon DescribeServiceAccessPolicies service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResult"> <summary> The result of a <code>DescribeServiceAccessPolicies</code> request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResult.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. <para> The access rules configured for the domain specified in the request. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeServiceAccessPoliciesResponse.DescribeServiceAccessPoliciesResult"> <summary> Gets and sets the DescribeServiceAccessPoliciesResult property. Represents the output of a DescribeServiceAccessPolicies operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersRequest"> <summary> Container for the parameters to the DescribeSuggesters operation. Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.Deployed"> <summary> Gets and sets the property Deployed. <para> Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersRequest.SuggesterNames"> <summary> Gets and sets the property SuggesterNames. <para> The suggesters you want to describe. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersResponse"> <summary> Configuration for accessing Amazon DescribeSuggesters service </summary> </member> <member name="T:Amazon.CloudSearch.Model.DescribeSuggestersResult"> <summary> The result of a <code>DescribeSuggesters</code> request. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersResult.Suggesters"> <summary> Gets and sets the property Suggesters. <para> The suggesters configured for the domain specified in the request. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DescribeSuggestersResponse.DescribeSuggestersResult"> <summary> Gets and sets the DescribeSuggestersResult property. Represents the output of a DescribeSuggesters operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.DisabledOperationException"> <summary> CloudSearch 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> Options for a search suggester. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.FuzzyMatching"> <summary> Gets and sets the property FuzzyMatching. <para> The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. 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> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.SortExpression"> <summary> Gets and sets the property SortExpression. <para> An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the <code>_score</code> value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DocumentSuggesterOptions.SourceField"> <summary> Gets and sets the property SourceField. <para> The name of the index field you want to use for suggestions. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.ARN"> <summary> Gets and sets the property ARN. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Created"> <summary> Gets and sets the property Created. <para> 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Deleted"> <summary> Gets and sets the property Deleted. <para> 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DocService"> <summary> Gets and sets the property DocService. <para> The service endpoint for updating documents in a search domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DomainId"> <summary> Gets and sets the property DomainId. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Limits"> <summary> Gets and sets the property Limits. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.Processing"> <summary> Gets and sets the property Processing. <para> True if processing is being done to activate the current domain configuration. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.RequiresIndexDocuments"> <summary> Gets and sets the property RequiresIndexDocuments. <para> True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchInstanceCount"> <summary> Gets and sets the property SearchInstanceCount. <para> The number of search instances that are available to process search requests. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchInstanceType"> <summary> Gets and sets the property SearchInstanceType. <para> The instance type that is being used to process search requests. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchPartitionCount"> <summary> Gets and sets the property SearchPartitionCount. <para> The number of partitions across which the search index is spread. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DomainStatus.SearchService"> <summary> Gets and sets the property SearchService. <para> The service endpoint for requesting search results from a search domain. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DoubleArrayOptions"> <summary> Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. 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.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleArrayOptions.SourceFields"> <summary> Gets and sets the property SourceFields. <para> A list of source fields to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.DoubleOptions"> <summary> Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.DoubleOptions.SourceField"> <summary> Gets and sets the property SourceField. <para> The name of the source field to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.Expression"> <summary> A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </summary> </member> <member name="P:Amazon.CloudSearch.Model.Expression.ExpressionName"> <summary> Gets and sets the property ExpressionName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.Expression.ExpressionValue"> <summary> Gets and sets the property ExpressionValue. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ExpressionStatus"> <summary> The value of an <code>Expression</code> and its current status. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ExpressionStatus.Options"> <summary> Gets and sets the property Options. <para> The expression that is evaluated for sorting while processing a search request. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.ExpressionStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsRequest"> <summary> Container for the parameters to the IndexDocuments operation. Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsResponse"> <summary> Configuration for accessing Amazon IndexDocuments service </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexDocumentsResult"> <summary> The result of an <code>IndexDocuments</code> request. Contains the status of the indexing operation, including the fields being indexed. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsResult.FieldNames"> <summary> Gets and sets the property FieldNames. <para> The names of the fields that are currently being indexed. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexDocumentsResponse.IndexDocumentsResult"> <summary> Gets and sets the IndexDocumentsResult property. Represents the output of a IndexDocuments operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexField"> <summary> Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DateArrayOptions"> <summary> Gets and sets the property DateArrayOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DateOptions"> <summary> Gets and sets the property DateOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DoubleArrayOptions"> <summary> Gets and sets the property DoubleArrayOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.DoubleOptions"> <summary> Gets and sets the property DoubleOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IndexFieldName"> <summary> Gets and sets the property IndexFieldName. <para> A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. </para> <para> Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. </para> <para> The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IndexFieldType"> <summary> Gets and sets the property IndexFieldType. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IntArrayOptions"> <summary> Gets and sets the property IntArrayOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.IntOptions"> <summary> Gets and sets the property IntOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LatLonOptions"> <summary> Gets and sets the property LatLonOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LiteralArrayOptions"> <summary> Gets and sets the property LiteralArrayOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.LiteralOptions"> <summary> Gets and sets the property LiteralOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.TextArrayOptions"> <summary> Gets and sets the property TextArrayOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexField.TextOptions"> <summary> Gets and sets the property TextOptions. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IndexFieldStatus"> <summary> The value of an <code>IndexField</code> and its current status. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexFieldStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IndexFieldStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.IntArrayOptions"> <summary> Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. 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.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntArrayOptions.SourceFields"> <summary> Gets and sets the property SourceFields. <para> A list of source fields to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.InternalException"> <summary> CloudSearch 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.IntOptions"> <summary> Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. 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.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.IntOptions.SourceField"> <summary> Gets and sets the property SourceField. <para> The name of the source field to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.InvalidTypeException"> <summary> CloudSearch 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> Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LatLonOptions.SourceField"> <summary> Gets and sets the property SourceField. </summary> </member> <member name="T:Amazon.CloudSearch.Model.LimitExceededException"> <summary> CloudSearch 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.Limits"> <summary> </summary> </member> <member name="P:Amazon.CloudSearch.Model.Limits.MaximumPartitionCount"> <summary> Gets and sets the property MaximumPartitionCount. </summary> </member> <member name="P:Amazon.CloudSearch.Model.Limits.MaximumReplicationCount"> <summary> Gets and sets the property MaximumReplicationCount. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesRequest"> <summary> Container for the parameters to the ListDomainNames operation. Lists all search domains owned by an account. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesResponse"> <summary> Configuration for accessing Amazon ListDomainNames service </summary> </member> <member name="T:Amazon.CloudSearch.Model.ListDomainNamesResult"> <summary> The result of a <code>ListDomainNames</code> request. Contains a list of the domains owned by an account. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ListDomainNamesResult.DomainNames"> <summary> Gets and sets the property DomainNames. <para> The names of the search domains owned by an account. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.ListDomainNamesResponse.ListDomainNamesResult"> <summary> Gets and sets the ListDomainNamesResult property. Represents the output of a ListDomainNames operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.LiteralArrayOptions"> <summary> Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralArrayOptions.SourceFields"> <summary> Gets and sets the property SourceFields. <para> A list of source fields to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.LiteralOptions"> <summary> Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Whether facet information can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Whether the contents of the field are searchable. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.LiteralOptions.SourceField"> <summary> Gets and sets the property SourceField. </summary> </member> <member name="T:Amazon.CloudSearch.Model.OptionStatus"> <summary> The status of domain configuration option. </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.CreationDate"> <summary> Gets and sets the property CreationDate. <para> A timestamp for when this option was created. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.PendingDeletion"> <summary> Gets and sets the property PendingDeletion. <para> Indicates that the option will be deleted once processing is complete. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.State"> <summary> Gets and sets the property State. <para> The state of processing a change to an option. Possible values: </para> <ul> <li> <code>RequiresIndexDocuments</code>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li> <code>Processing</code>: the option's latest value is in the process of being activated. </li> <li> <code>Active</code>: the option's latest value is completely deployed.</li> <li> <code>FailedToValidate</code>: 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> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.UpdateDate"> <summary> Gets and sets the property UpdateDate. <para> A timestamp for when this option was last updated. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.OptionStatus.UpdateVersion"> <summary> Gets and sets the property UpdateVersion. <para> A unique integer that indicates when this option was last updated. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.ResourceNotFoundException"> <summary> CloudSearch 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> The desired instance type and desired number of replicas of each index partition. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParameters.DesiredInstanceType"> <summary> Gets and sets the property DesiredInstanceType. <para> The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParameters.DesiredPartitionCount"> <summary> Gets and sets the property DesiredPartitionCount. <para> The number of partitions you want to preconfigure for your domain. Only valid when you select <code>m2.2xlarge</code> as the desired instance type. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParameters.DesiredReplicationCount"> <summary> Gets and sets the property DesiredReplicationCount. <para> The number of replicas you want to preconfigure for each index partition. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.ScalingParametersStatus"> <summary> The status and configuration of a search domain's scaling parameters. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParametersStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ScalingParametersStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.ServiceEndpoint"> <summary> The endpoint to which service requests can be submitted. </summary> </member> <member name="P:Amazon.CloudSearch.Model.ServiceEndpoint.Endpoint"> <summary> Gets and sets the property Endpoint. </summary> </member> <member name="T:Amazon.CloudSearch.Model.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: <code>FuzzyMatching</code>, <code>SortExpression</code>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.Suggester.DocumentSuggesterOptions"> <summary> Gets and sets the property DocumentSuggesterOptions. </summary> </member> <member name="P:Amazon.CloudSearch.Model.Suggester.SuggesterName"> <summary> Gets and sets the property SuggesterName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.SuggesterStatus"> <summary> The value of a <code>Suggester</code> and its current status. </summary> </member> <member name="P:Amazon.CloudSearch.Model.SuggesterStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.SuggesterStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch.Model.TextArrayOptions"> <summary> Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.AnalysisScheme"> <summary> Gets and sets the property AnalysisScheme. <para> The name of an analysis scheme for a <code>text-array</code> field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.HighlightEnabled"> <summary> Gets and sets the property HighlightEnabled. <para> Whether highlights can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextArrayOptions.SourceFields"> <summary> Gets and sets the property SourceFields. <para> A list of source fields to map to the field. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.TextOptions"> <summary> Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.AnalysisScheme"> <summary> Gets and sets the property AnalysisScheme. <para> The name of an analysis scheme for a <code>text</code> field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. A value to use for the field if the field isn't specified for a document. </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.HighlightEnabled"> <summary> Gets and sets the property HighlightEnabled. <para> Whether highlights can be returned for the field. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.ReturnEnabled"> <summary> Gets and sets the property ReturnEnabled. <para> Whether the contents of the field can be returned in the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.SortEnabled"> <summary> Gets and sets the property SortEnabled. <para> Whether the field can be used to sort the search results. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.TextOptions.SourceField"> <summary> Gets and sets the property SourceField. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest"> <summary> Container for the parameters to the UpdateAvailabilityOptions operation. Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsRequest.MultiAZ"> <summary> Gets and sets the property MultiAZ. <para> 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 <code>false</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResponse"> <summary> Configuration for accessing Amazon UpdateAvailabilityOptions service </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResult"> <summary> The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResult.AvailabilityOptions"> <summary> Gets and sets the property AvailabilityOptions. <para> The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateAvailabilityOptionsResponse.UpdateAvailabilityOptionsResult"> <summary> Gets and sets the UpdateAvailabilityOptionsResult property. Represents the output of a UpdateAvailabilityOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersRequest"> <summary> Container for the parameters to the UpdateScalingParameters operation. Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersRequest.ScalingParameters"> <summary> Gets and sets the property ScalingParameters. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersResponse"> <summary> Configuration for accessing Amazon UpdateScalingParameters service </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateScalingParametersResult"> <summary> The result of a <code>UpdateScalingParameters</code> request. Contains the status of the newly-configured scaling parameters. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersResult.ScalingParameters"> <summary> Gets and sets the property ScalingParameters. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateScalingParametersResponse.UpdateScalingParametersResult"> <summary> Gets and sets the UpdateScalingParametersResult property. Represents the output of a UpdateScalingParameters operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest"> <summary> Container for the parameters to the UpdateServiceAccessPolicies operation. Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank"> Configuring Access for an Amazon CloudSearch Domain</a>. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. <para> The access rules you want to configure. These rules replace any existing rules. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResponse"> <summary> Configuration for accessing Amazon UpdateServiceAccessPolicies service </summary> </member> <member name="T:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResult"> <summary> The result of an <code>UpdateServiceAccessPolicies</code> request. Contains the new access policies. </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResult.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. <para> The access rules configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch.Model.UpdateServiceAccessPoliciesResponse.UpdateServiceAccessPoliciesResult"> <summary> Gets and sets the UpdateServiceAccessPoliciesResult property. Represents the output of a UpdateServiceAccessPolicies operation. </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AccessPoliciesStatusUnmarshaller"> <summary> Response Unmarshaller for AccessPoliciesStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisOptionsUnmarshaller"> <summary> Response Unmarshaller for AnalysisOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisSchemeStatusUnmarshaller"> <summary> Response Unmarshaller for AnalysisSchemeStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AnalysisSchemeUnmarshaller"> <summary> Response Unmarshaller for AnalysisScheme Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.AvailabilityOptionsStatusUnmarshaller"> <summary> Response Unmarshaller for AvailabilityOptionsStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.BuildSuggestersRequestMarshaller"> <summary> BuildSuggesters 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.CreateDomainRequestMarshaller"> <summary> CreateDomain 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.DateArrayOptionsUnmarshaller"> <summary> Response Unmarshaller for DateArrayOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DateOptionsUnmarshaller"> <summary> Response Unmarshaller for DateOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DefineAnalysisSchemeRequestMarshaller"> <summary> DefineAnalysisScheme 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.DefineExpressionRequestMarshaller"> <summary> DefineExpression 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.DefineIndexFieldRequestMarshaller"> <summary> DefineIndexField 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.DefineSuggesterRequestMarshaller"> <summary> DefineSuggester 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.DeleteAnalysisSchemeRequestMarshaller"> <summary> DeleteAnalysisScheme 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.DeleteDomainRequestMarshaller"> <summary> DeleteDomain 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.DeleteExpressionRequestMarshaller"> <summary> DeleteExpression 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.DeleteIndexFieldRequestMarshaller"> <summary> DeleteIndexField 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.DeleteSuggesterRequestMarshaller"> <summary> DeleteSuggester 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.DescribeAnalysisSchemesRequestMarshaller"> <summary> DescribeAnalysisSchemes 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.DescribeAvailabilityOptionsRequestMarshaller"> <summary> DescribeAvailabilityOptions 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.DescribeDomainsRequestMarshaller"> <summary> DescribeDomains 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.DescribeExpressionsRequestMarshaller"> <summary> DescribeExpressions 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.DescribeIndexFieldsRequestMarshaller"> <summary> DescribeIndexFields 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.DescribeScalingParametersRequestMarshaller"> <summary> DescribeScalingParameters 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.DescribeServiceAccessPoliciesRequestMarshaller"> <summary> DescribeServiceAccessPolicies 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.DescribeSuggestersRequestMarshaller"> <summary> DescribeSuggesters 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.DocumentSuggesterOptionsUnmarshaller"> <summary> Response Unmarshaller for DocumentSuggesterOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DomainStatusUnmarshaller"> <summary> Response Unmarshaller for DomainStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DoubleArrayOptionsUnmarshaller"> <summary> Response Unmarshaller for DoubleArrayOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.DoubleOptionsUnmarshaller"> <summary> Response Unmarshaller for DoubleOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ExpressionStatusUnmarshaller"> <summary> Response Unmarshaller for ExpressionStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ExpressionUnmarshaller"> <summary> Response Unmarshaller for Expression Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexDocumentsRequestMarshaller"> <summary> IndexDocuments 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.IndexFieldStatusUnmarshaller"> <summary> Response Unmarshaller for IndexFieldStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IndexFieldUnmarshaller"> <summary> Response Unmarshaller for IndexField Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IntArrayOptionsUnmarshaller"> <summary> Response Unmarshaller for IntArrayOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.IntOptionsUnmarshaller"> <summary> Response Unmarshaller for IntOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LatLonOptionsUnmarshaller"> <summary> Response Unmarshaller for LatLonOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LimitsUnmarshaller"> <summary> Response Unmarshaller for Limits Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ListDomainNamesRequestMarshaller"> <summary> ListDomainNames 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.LiteralArrayOptionsUnmarshaller"> <summary> Response Unmarshaller for LiteralArrayOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.LiteralOptionsUnmarshaller"> <summary> Response Unmarshaller for LiteralOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.OptionStatusUnmarshaller"> <summary> Response Unmarshaller for OptionStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ScalingParametersStatusUnmarshaller"> <summary> Response Unmarshaller for ScalingParametersStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ScalingParametersUnmarshaller"> <summary> Response Unmarshaller for ScalingParameters Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.ServiceEndpointUnmarshaller"> <summary> Response Unmarshaller for ServiceEndpoint Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.SuggesterStatusUnmarshaller"> <summary> Response Unmarshaller for SuggesterStatus Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.SuggesterUnmarshaller"> <summary> Response Unmarshaller for Suggester Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.TextArrayOptionsUnmarshaller"> <summary> Response Unmarshaller for TextArrayOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.TextOptionsUnmarshaller"> <summary> Response Unmarshaller for TextOptions Object </summary> </member> <member name="T:Amazon.CloudSearch.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsRequestMarshaller"> <summary> UpdateAvailabilityOptions 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.UpdateScalingParametersRequestMarshaller"> <summary> UpdateScalingParameters 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.UpdateServiceAccessPoliciesRequestMarshaller"> <summary> UpdateServiceAccessPolicies 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_2011_02_01.AmazonCloudSearchClient"> <summary> Implementation for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch"> <summary> Interface for accessing CloudSearch Amazon CloudSearch Configuration Service <para> You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action. </para> <para> The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> Creates a new search domain. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginCreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndCreateDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDomain operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> Configures an <code>IndexField</code> for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineIndexField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> Configures a <code>RankExpression</code> for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression service method.</param> <returns>The response from the DefineRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDefineRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DefineRankExpression operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineRankExpression.</param> <returns>Returns a DefineRankExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteDomain(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDomain operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code>IndexField</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteIndexField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteIndexField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> Removes a <code>RankExpression</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression service method.</param> <returns>The response from the DeleteRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDeleteRankExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRankExpression operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRankExpression.</param> <returns>Returns a DeleteRankExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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_2011_02_01.IAmazonCloudSearch.EndDescribeAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> Gets the default search field configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField service method.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDefaultSearchField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDefaultSearchField.</param> <returns>Returns a DescribeDefaultSearchFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeDomains(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDomains operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeIndexFields(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions service method.</param> <returns>The response from the DescribeRankExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeRankExpressions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRankExpressions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRankExpressions.</param> <returns>Returns a DescribeRankExpressionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the resource-based policies that control access to the domain's document and search services. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> Gets the stemming dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions service method.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStemmingOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStemmingOptions.</param> <returns>Returns a DescribeStemmingOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> Gets the stopwords configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions service method.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStopwordOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStopwordOptions.</param> <returns>Returns a DescribeStopwordOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> Gets the synonym dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions service method.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginDescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndDescribeSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSynonymOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSynonymOptions.</param> <returns>Returns a DescribeSynonymOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest text processing options and <code>IndexFields</code>. This operation must be invoked to make options whose <a>OptionStatus</a> has <code>OptionState</code> of <code>RequiresIndexDocuments</code> visible in search results. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginIndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndIndexDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the IndexDocuments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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_2011_02_01.IAmazonCloudSearch.EndUpdateAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField service method.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateDefaultSearchField(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDefaultSearchField operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultSearchField.</param> <returns>Returns a UpdateDefaultSearchFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateServiceAccessPolicies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions service method.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateStemmingOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStemmingOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStemmingOptions.</param> <returns>Returns a UpdateStemmingOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions service method.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateStopwordOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateStopwordOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStopwordOptions.</param> <returns>Returns a UpdateStopwordOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions service method.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch.BeginUpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudSearch.EndUpdateSynonymOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateSynonymOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSynonymOptions.</param> <returns>Returns a UpdateSynonymOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Credentials and an AmazonCloudSearchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig)"> <summary> Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.CreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest)"> <summary> Creates a new search domain. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain service method.</param> <returns>The response from the CreateDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginCreateDomain(Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDomain.</param> <returns>Returns a CreateDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest)"> <summary> Configures an <code>IndexField</code> for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField service method.</param> <returns>The response from the DefineIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDefineIndexField(Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineIndexField.</param> <returns>Returns a DefineIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest)"> <summary> Configures a <code>RankExpression</code> for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression service method.</param> <returns>The response from the DefineRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDefineRankExpression(Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DefineRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DefineRankExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDefineRankExpression.</param> <returns>Returns a DefineRankExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest)"> <summary> Permanently deletes a search domain and all of its data. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain service method.</param> <returns>The response from the DeleteDomain service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteDomain(Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDomain operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDomain operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDomain.</param> <returns>Returns a DeleteDomainResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest)"> <summary> Removes an <code>IndexField</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField service method.</param> <returns>The response from the DeleteIndexField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteIndexField(Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteIndexField operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteIndexField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteIndexField.</param> <returns>Returns a DeleteIndexFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest)"> <summary> Removes a <code>RankExpression</code> from the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression service method.</param> <returns>The response from the DeleteRankExpression service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDeleteRankExpression(Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRankExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRankExpression operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRankExpression.</param> <returns>Returns a DeleteRankExpressionResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest)"> <summary> Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions service method.</param> <returns>The response from the DescribeAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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_2011_02_01.AmazonCloudSearchClient.EndDescribeAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityOptions.</param> <returns>Returns a DescribeAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest)"> <summary> Gets the default search field configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField service method.</param> <returns>The response from the DescribeDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDefaultSearchField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDefaultSearchField.</param> <returns>Returns a DescribeDefaultSearchFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest)"> <summary> Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains service method.</param> <returns>The response from the DescribeDomains service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeDomains(Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDomains operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDomains operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDomains.</param> <returns>Returns a DescribeDomainsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest)"> <summary> Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields service method.</param> <returns>The response from the DescribeIndexFields service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeIndexFields(Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeIndexFields operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeIndexFields operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeIndexFields.</param> <returns>Returns a DescribeIndexFieldsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest)"> <summary> Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions service method.</param> <returns>The response from the DescribeRankExpressions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeRankExpressions(Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRankExpressions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRankExpressions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRankExpressions.</param> <returns>Returns a DescribeRankExpressionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest)"> <summary> Gets information about the resource-based policies that control access to the domain's document and search services. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method.</param> <returns>The response from the DescribeServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServiceAccessPolicies.</param> <returns>Returns a DescribeServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest)"> <summary> Gets the stemming dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions service method.</param> <returns>The response from the DescribeStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStemmingOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStemmingOptions.</param> <returns>Returns a DescribeStemmingOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest)"> <summary> Gets the stopwords configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions service method.</param> <returns>The response from the DescribeStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStopwordOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStopwordOptions.</param> <returns>Returns a DescribeStopwordOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.DescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest)"> <summary> Gets the synonym dictionary configured for the search domain. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions service method.</param> <returns>The response from the DescribeSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginDescribeSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSynonymOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSynonymOptions.</param> <returns>Returns a DescribeSynonymOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.IndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest)"> <summary> Tells the search domain to start indexing its documents using the latest text processing options and <code>IndexFields</code>. This operation must be invoked to make options whose <a>OptionStatus</a> has <code>OptionState</code> of <code>RequiresIndexDocuments</code> visible in search results. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments service method.</param> <returns>The response from the IndexDocuments service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginIndexDocuments(Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the IndexDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the IndexDocuments operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginIndexDocuments.</param> <returns>Returns a IndexDocumentsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest)"> <summary> Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions service method.</param> <returns>The response from the UpdateAvailabilityOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> The request was rejected because it attempted an operation which is not enabled. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateAvailabilityOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateAvailabilityOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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_2011_02_01.AmazonCloudSearchClient.EndUpdateAvailabilityOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateAvailabilityOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateAvailabilityOptions.</param> <returns>Returns a UpdateAvailabilityOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest)"> <summary> Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField service method.</param> <returns>The response from the UpdateDefaultSearchField service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateDefaultSearchField(Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDefaultSearchField operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDefaultSearchField operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDefaultSearchField.</param> <returns>Returns a UpdateDefaultSearchFieldResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest)"> <summary> Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method.</param> <returns>The response from the UpdateServiceAccessPolicies service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateServiceAccessPolicies(Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateServiceAccessPolicies operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateServiceAccessPolicies.</param> <returns>Returns a UpdateServiceAccessPoliciesResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest)"> <summary> Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions service method.</param> <returns>The response from the UpdateStemmingOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateStemmingOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStemmingOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStemmingOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStemmingOptions.</param> <returns>Returns a UpdateStemmingOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest)"> <summary> Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions service method.</param> <returns>The response from the UpdateStopwordOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateStopwordOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateStopwordOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateStopwordOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateStopwordOptions.</param> <returns>Returns a UpdateStopwordOptionsResult from CloudSearch.</returns> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.UpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest)"> <summary> Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions service method.</param> <returns>The response from the UpdateSynonymOptions service method, as returned by CloudSearch.</returns> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> An error occurred while processing the request. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/">Service Health Dashboard</a>. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.InvalidTypeException"> The request was rejected because it specified an invalid type definition. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.LimitExceededException"> The request was rejected because a resource limit has already been met. </exception> <exception cref="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> The request was rejected because it attempted to reference a resource that does not exist. </exception> </member> <member name="M:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient.BeginUpdateSynonymOptions(Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateSynonymOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateSynonymOptions operation on AmazonCloudSearchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateSynonymOptions.</param> <returns>Returns a UpdateSynonymOptionsResult from CloudSearch.</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchConfig"> <summary> Configuration for accessing Amazon CloudSearch 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="T:Amazon.CloudSearch_2011_02_01.IndexFieldType"> <summary> Constants used for properties of type IndexFieldType. </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.IndexFieldType.Literal"> <summary> Constant Literal for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.IndexFieldType.Text"> <summary> Constant Text for IndexFieldType </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.IndexFieldType.Uint"> <summary> Constant Uint for IndexFieldType </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IndexFieldType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.IndexFieldType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.OptionState"> <summary> Constants used for properties of type OptionState. </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.OptionState.Active"> <summary> Constant Active for OptionState </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.OptionState.Processing"> <summary> Constant Processing for OptionState </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.OptionState.RequiresIndexDocuments"> <summary> Constant RequiresIndexDocuments for OptionState </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.OptionState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.OptionState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.SourceDataFunction"> <summary> Constants used for properties of type SourceDataFunction. </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.SourceDataFunction.Copy"> <summary> Constant Copy for SourceDataFunction </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.SourceDataFunction.Map"> <summary> Constant Map for SourceDataFunction </summary> </member> <member name="F:Amazon.CloudSearch_2011_02_01.SourceDataFunction.TrimTitle"> <summary> Constant TrimTitle for SourceDataFunction </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.SourceDataFunction.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.SourceDataFunction.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus"> <summary> A <code>PolicyDocument</code> that specifies access policies for the search domain's services, and the current status of those policies. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AccessPoliciesStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.AmazonCloudSearchRequest"> <summary> Base class for CloudSearch operation requests. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.AvailabilityOptionsStatus"> <summary> The status and configuration of the domain's availability options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AvailabilityOptionsStatus.Options"> <summary> Gets and sets the property Options. <para> The availability options configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.AvailabilityOptionsStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.BaseException"> <summary> CloudSearch 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. Creates a new search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResponse"> <summary> Configuration for accessing Amazon CreateDomain service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResult"> <summary> A response message that contains the status of a newly created domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResult.DomainStatus"> <summary> Gets and sets the property DomainStatus. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.CreateDomainResponse.CreateDomainResult"> <summary> Gets and sets the CreateDomainResult property. Represents the output of a CreateDomain operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus"> <summary> The value of the <code>DefaultSearchField</code> configured for this search domain and its current status. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.Options"> <summary> Gets and sets the property Options. <para> The name of the <code>IndexField</code> to use as the default search field. The default is an empty string, which automatically searches all text fields. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefaultSearchFieldStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest"> <summary> Container for the parameters to the DefineIndexField operation. Configures an <code>IndexField</code> for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldRequest.IndexField"> <summary> Gets and sets the property IndexField. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResponse"> <summary> Configuration for accessing Amazon DefineIndexField service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResult"> <summary> A response message that contains the status of an updated index field. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResult.IndexField"> <summary> Gets and sets the property IndexField. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineIndexFieldResponse.DefineIndexFieldResult"> <summary> Gets and sets the DefineIndexFieldResult property. Represents the output of a DefineIndexField operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest"> <summary> Container for the parameters to the DefineRankExpression operation. Configures a <code>RankExpression</code> for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionRequest.RankExpression"> <summary> Gets and sets the property RankExpression. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResponse"> <summary> Configuration for accessing Amazon DefineRankExpression service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResult"> <summary> A response message that contains the status of an updated <code>RankExpression</code>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResult.RankExpression"> <summary> Gets and sets the property RankExpression. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DefineRankExpressionResponse.DefineRankExpressionResult"> <summary> Gets and sets the DefineRankExpressionResult property. Represents the output of a DefineRankExpression operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest"> <summary> Container for the parameters to the DeleteDomain operation. Permanently deletes a search domain and all of its data. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResponse"> <summary> Configuration for accessing Amazon DeleteDomain service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResult"> <summary> 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="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResult.DomainStatus"> <summary> Gets and sets the property DomainStatus. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteDomainResponse.DeleteDomainResult"> <summary> Gets and sets the DeleteDomainResult property. Represents the output of a DeleteDomain operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest"> <summary> Container for the parameters to the DeleteIndexField operation. Removes an <code>IndexField</code> from the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldRequest.IndexFieldName"> <summary> Gets and sets the property IndexFieldName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResponse"> <summary> Configuration for accessing Amazon DeleteIndexField service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResult"> <summary> A response message that contains the status of a deleted index field. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResult.IndexField"> <summary> Gets and sets the property IndexField. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteIndexFieldResponse.DeleteIndexFieldResult"> <summary> Gets and sets the DeleteIndexFieldResult property. Represents the output of a DeleteIndexField operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest"> <summary> Container for the parameters to the DeleteRankExpression operation. Removes a <code>RankExpression</code> from the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionRequest.RankName"> <summary> Gets and sets the property RankName. <para> The name of the <code>RankExpression</code> to delete. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResponse"> <summary> Configuration for accessing Amazon DeleteRankExpression service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResult"> <summary> A response message that contains the status of a deleted <code>RankExpression</code>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResult.RankExpression"> <summary> Gets and sets the property RankExpression. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DeleteRankExpressionResponse.DeleteRankExpressionResult"> <summary> Gets and sets the DeleteRankExpressionResult property. Represents the output of a DeleteRankExpression operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest"> <summary> Container for the parameters to the DescribeAvailabilityOptions operation. Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. <para> The name of the domain you want to describe. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsResponse"> <summary> Configuration for accessing Amazon DescribeAvailabilityOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsResult"> <summary> The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsResult.AvailabilityOptions"> <summary> Gets and sets the property AvailabilityOptions. <para> The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeAvailabilityOptionsResponse.DescribeAvailabilityOptionsResult"> <summary> Gets and sets the DescribeAvailabilityOptionsResult property. Represents the output of a DescribeAvailabilityOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest"> <summary> Container for the parameters to the DescribeDefaultSearchField operation. Gets the default search field configured for the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResponse"> <summary> Configuration for accessing Amazon DescribeDefaultSearchField service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResult"> <summary> A response message that contains the default search field for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResult.DefaultSearchField"> <summary> Gets and sets the property DefaultSearchField. <para> The name of the <code>IndexField</code> to use for search requests issued with the <code>q</code> parameter. The default is the empty string, which automatically searches all text fields. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDefaultSearchFieldResponse.DescribeDefaultSearchFieldResult"> <summary> Gets and sets the DescribeDefaultSearchFieldResult property. Represents the output of a DescribeDefaultSearchField operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest"> <summary> Container for the parameters to the DescribeDomains operation. Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsRequest.DomainNames"> <summary> Gets and sets the property DomainNames. <para> Limits the DescribeDomains response to the specified search domains. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResponse"> <summary> Configuration for accessing Amazon DescribeDomains service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult"> <summary> A response message that contains the status of one or more domains. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResult.DomainStatusList"> <summary> Gets and sets the property DomainStatusList. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeDomainsResponse.DescribeDomainsResult"> <summary> Gets and sets the DescribeDomainsResult property. Represents the output of a DescribeDomains operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest"> <summary> Container for the parameters to the DescribeIndexFields operation. Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsRequest.FieldNames"> <summary> Gets and sets the property FieldNames. <para> Limits the <code>DescribeIndexFields</code> response to the specified fields. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResponse"> <summary> Configuration for accessing Amazon DescribeIndexFields service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult"> <summary> A response message that contains the index fields for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResult.IndexFields"> <summary> Gets and sets the property IndexFields. <para> The index fields configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeIndexFieldsResponse.DescribeIndexFieldsResult"> <summary> Gets and sets the DescribeIndexFieldsResult property. Represents the output of a DescribeIndexFields operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest"> <summary> Container for the parameters to the DescribeRankExpressions operation. Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsRequest.RankNames"> <summary> Gets and sets the property RankNames. <para> Limits the <code>DescribeRankExpressions</code> response to the specified fields. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResponse"> <summary> Configuration for accessing Amazon DescribeRankExpressions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult"> <summary> A response message that contains the rank expressions for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResult.RankExpressions"> <summary> Gets and sets the property RankExpressions. <para> The rank expressions configured for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeRankExpressionsResponse.DescribeRankExpressionsResult"> <summary> Gets and sets the DescribeRankExpressionsResult property. Represents the output of a DescribeRankExpressions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest"> <summary> Container for the parameters to the DescribeServiceAccessPolicies operation. Gets information about the resource-based policies that control access to the domain's document and search services. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResponse"> <summary> Configuration for accessing Amazon DescribeServiceAccessPolicies service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResult"> <summary> A response message that contains the access policies for a domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResult.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeServiceAccessPoliciesResponse.DescribeServiceAccessPoliciesResult"> <summary> Gets and sets the DescribeServiceAccessPoliciesResult property. Represents the output of a DescribeServiceAccessPolicies operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest"> <summary> Container for the parameters to the DescribeStemmingOptions operation. Gets the stemming dictionary configured for the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResponse"> <summary> Configuration for accessing Amazon DescribeStemmingOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResult"> <summary> A response message that contains the stemming options for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResult.Stems"> <summary> Gets and sets the property Stems. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStemmingOptionsResponse.DescribeStemmingOptionsResult"> <summary> Gets and sets the DescribeStemmingOptionsResult property. Represents the output of a DescribeStemmingOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest"> <summary> Container for the parameters to the DescribeStopwordOptions operation. Gets the stopwords configured for the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResponse"> <summary> Configuration for accessing Amazon DescribeStopwordOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResult"> <summary> A response message that contains the stopword options for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResult.Stopwords"> <summary> Gets and sets the property Stopwords. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeStopwordOptionsResponse.DescribeStopwordOptionsResult"> <summary> Gets and sets the DescribeStopwordOptionsResult property. Represents the output of a DescribeStopwordOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest"> <summary> Container for the parameters to the DescribeSynonymOptions operation. Gets the synonym dictionary configured for the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResponse"> <summary> Configuration for accessing Amazon DescribeSynonymOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResult"> <summary> A response message that contains the synonym options for a search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResult.Synonyms"> <summary> Gets and sets the property Synonyms. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DescribeSynonymOptionsResponse.DescribeSynonymOptionsResult"> <summary> Gets and sets the DescribeSynonymOptionsResult property. Represents the output of a DescribeSynonymOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.DisabledOperationException"> <summary> CloudSearch exception </summary> </member> <member name="M:Amazon.CloudSearch_2011_02_01.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_2011_02_01.Model.DomainStatus"> <summary> The current status of the search domain. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Created"> <summary> Gets and sets the property Created. <para> 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Deleted"> <summary> Gets and sets the property Deleted. <para> 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. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DocService"> <summary> Gets and sets the property DocService. <para> The service endpoint for updating documents in a search domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DomainId"> <summary> Gets and sets the property DomainId. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.NumSearchableDocs"> <summary> Gets and sets the property NumSearchableDocs. <para> The number of documents that have been submitted to the domain and indexed. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.Processing"> <summary> Gets and sets the property Processing. <para> True if processing is being done to activate the current domain configuration. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.RequiresIndexDocuments"> <summary> Gets and sets the property RequiresIndexDocuments. <para> True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchInstanceCount"> <summary> Gets and sets the property SearchInstanceCount. <para> The number of search instances that are available to process search requests. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchInstanceType"> <summary> Gets and sets the property SearchInstanceType. <para> The instance type (such as search.m1.small) that is being used to process search requests. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchPartitionCount"> <summary> Gets and sets the property SearchPartitionCount. <para> The number of partitions across which the search index is spread. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.DomainStatus.SearchService"> <summary> Gets and sets the property SearchService. <para> The service endpoint for requesting search results from a search domain. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest"> <summary> Container for the parameters to the IndexDocuments operation. Tells the search domain to start indexing its documents using the latest text processing options and <code>IndexFields</code>. This operation must be invoked to make options whose <a>OptionStatus</a> has <code>OptionState</code> of <code>RequiresIndexDocuments</code> visible in search results. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResponse"> <summary> Configuration for accessing Amazon IndexDocuments service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult"> <summary> The result of an <code>IndexDocuments</code> action. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResult.FieldNames"> <summary> Gets and sets the property FieldNames. <para> The names of the fields that are currently being processed due to an <code>IndexDocuments</code> action. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexDocumentsResponse.IndexDocumentsResult"> <summary> Gets and sets the IndexDocumentsResult property. Represents the output of a IndexDocuments operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexField"> <summary> Defines a field in the index, including its name, type, and the source of its data. The <code>IndexFieldType</code> indicates which of the options will be present. It is invalid to specify options for a type other than the <code>IndexFieldType</code>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.IndexFieldName"> <summary> Gets and sets the property IndexFieldName. <para> 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> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.IndexFieldType"> <summary> Gets and sets the property IndexFieldType. <para> 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> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.LiteralOptions"> <summary> Gets and sets the property LiteralOptions. <para> Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type literal. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.SourceAttributes"> <summary> Gets and sets the property SourceAttributes. <para> 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 <code>IndexField</code>. 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 <code>IndexField</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.TextOptions"> <summary> Gets and sets the property TextOptions. <para> Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type text. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexField.UIntOptions"> <summary> Gets and sets the property UIntOptions. <para> Options for an unsigned integer field. Present if <code>IndexFieldType</code> specifies the field is of type unsigned integer. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus"> <summary> The value of an <code>IndexField</code> and its current status. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.IndexFieldStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.InternalException"> <summary> CloudSearch 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.InvalidTypeException"> <summary> CloudSearch 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> CloudSearch 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> Options that define a literal field in the search index. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value for a literal field. Optional. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Specifies whether facets are enabled for this field. Default: False. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.ResultEnabled"> <summary> Gets and sets the property ResultEnabled. <para> Specifies whether values of this field can be returned in search results and used for ranking. Default: False. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.LiteralOptions.SearchEnabled"> <summary> Gets and sets the property SearchEnabled. <para> Specifies whether search is enabled for this field. Default: False. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression"> <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="P:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.RankExpression"> <summary> Gets and sets the property RankExpression. <para> The expression to evaluate for ranking or thresholding while processing a search request. The <code>RankExpression</code> syntax is based on JavaScript expressions and supports: </para> <ul> <li>Integer, floating point, hex and octal literals</li> <li>Shortcut evaluation of logical operators such that an expression <code>a || b</code> evaluates to the value <code>a</code>, if <code>a</code> is true, without evaluating <code>b</code> at all</li> <li>JavaScript order of precedence for operators</li> <li>Arithmetic operators: <code>+ - * / %</code> </li> <li>Boolean operators (including the ternary operator)</li> <li>Bitwise operators</li> <li>Comparison operators</li> <li>Common mathematic functions: <code>abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow</code> </li> <li>Trigonometric library functions: <code>acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan</code> </li> <li>Random generation of a number between 0 and 1: <code>rand</code> </li> <li>Current time in epoch: <code>time</code> </li> <li>The <code>min max</code> functions that operate on a variable argument list</li> </ul> <para> Intermediate results are calculated as double precision floating point values. The final return value of a <code>RankExpression</code> 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. </para> <para> The source data for a <code>RankExpression</code> can be the name of an <code>IndexField</code> of type uint, another <code>RankExpression</code> 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 <code>IndexField</code> in the document. </para> <para> For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.NamedRankExpression.RankName"> <summary> Gets and sets the property RankName. <para> 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> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.OptionStatus"> <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="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.CreationDate"> <summary> Gets and sets the property CreationDate. <para> A timestamp for when this option was created. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.PendingDeletion"> <summary> Gets and sets the property PendingDeletion. <para> Indicates that the option will be deleted once processing is complete. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.State"> <summary> Gets and sets the property State. <para> The state of processing a change to an option. Possible values: </para> <ul> <li> <code>RequiresIndexDocuments</code>: the option's latest value will not be visible in searches until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li> <code>Processing</code>: the option's latest value is not yet visible in all searches but is in the process of being activated. </li> <li> <code>Active</code>: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in <code>Diagnostics</code>.</li> </ul> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.UpdateDate"> <summary> Gets and sets the property UpdateDate. <para> A timestamp for when this option was last updated. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.OptionStatus.UpdateVersion"> <summary> Gets and sets the property UpdateVersion. <para> A unique integer that indicates when this option was last updated. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus"> <summary> The value of a <code>RankExpression</code> and its current status. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.Options"> <summary> Gets and sets the property Options. <para> The expression that is evaluated for ranking or thresholding while processing a search request. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.RankExpressionStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.ResourceNotFoundException"> <summary> CloudSearch 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> 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 <a>UpdateServiceAccessPolicies</a>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.Arn"> <summary> Gets and sets the property Arn. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.ServiceEndpoint.Endpoint"> <summary> Gets and sets the property Endpoint. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute"> <summary> 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. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataCopy"> <summary> Gets and sets the property SourceDataCopy. <para> Copies data from a source document attribute to an <code>IndexField</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataFunction"> <summary> Gets and sets the property SourceDataFunction. <para> Identifies the transformation to apply when copying data from a source attribute. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataMap"> <summary> Gets and sets the property SourceDataMap. <para> Maps source document attribute values to new values when populating the <code>IndexField</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceAttribute.SourceDataTrimTitle"> <summary> Gets and sets the property SourceDataTrimTitle. <para> Trims common title words from a source document attribute when populating an <code>IndexField</code>. This can be used to create an <code>IndexField</code> you can use for sorting. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceData"> <summary> The source attribute name and an optional default value to use if a document doesn't have an attribute of that name. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceData.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value to use if the source attribute is not specified in a document. Optional. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceData.SourceName"> <summary> Gets and sets the property SourceName. <para> The name of the document source field to add to this <code>IndexField</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap"> <summary> Specifies how to map source attribute values to custom values when populating an <code>IndexField</code>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.Cases"> <summary> Gets and sets the property Cases. <para> A map that translates source field values to custom values. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value to use if the source attribute is not specified in a document. Optional. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataMap.SourceName"> <summary> Gets and sets the property SourceName. <para> The name of the document source field to add to this <code>IndexField</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle"> <summary> Specifies how to trim common words from the beginning of a field to enable title sorting by that field. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value to use if the source attribute is not specified in a document. Optional. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.Language"> <summary> Gets and sets the property Language. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.Separator"> <summary> Gets and sets the property Separator. <para> The separator that follows the text to trim. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SourceDataTrimTitle.SourceName"> <summary> Gets and sets the property SourceName. <para> The name of the document source field to add to this <code>IndexField</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus"> <summary> The stemming options configured for this search domain and the current status of those options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StemmingOptionsStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus"> <summary> The stopword options configured for this search domain and the current status of those options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.StopwordOptionsStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus"> <summary> The synonym options configured for this search domain and the current status of those options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.Options"> <summary> Gets and sets the property Options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.SynonymOptionsStatus.Status"> <summary> Gets and sets the property Status. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.TextOptions"> <summary> Options that define a text field in the search index. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value for a text field. Optional. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.FacetEnabled"> <summary> Gets and sets the property FacetEnabled. <para> Specifies whether facets are enabled for this field. Default: False. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.ResultEnabled"> <summary> Gets and sets the property ResultEnabled. <para> Specifies whether values of this field can be returned in search results and used for ranking. Default: False. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.TextOptions.TextProcessor"> <summary> Gets and sets the property TextProcessor. <para> The text processor to apply to this field. Optional. Possible values: </para> <ul> <li> <code>cs_text_no_stemming</code>: turns off stemming for the field.</li> </ul> <para> Default: none </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UIntOptions"> <summary> Options that define a <code>uint</code> field in the search index. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UIntOptions.DefaultValue"> <summary> Gets and sets the property DefaultValue. <para> The default value for an unsigned integer field. Optional. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest"> <summary> Container for the parameters to the UpdateAvailabilityOptions operation. Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsRequest.MultiAZ"> <summary> Gets and sets the property MultiAZ. <para> 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 <code>false</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsResponse"> <summary> Configuration for accessing Amazon UpdateAvailabilityOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsResult"> <summary> The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsResult.AvailabilityOptions"> <summary> Gets and sets the property AvailabilityOptions. <para> The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateAvailabilityOptionsResponse.UpdateAvailabilityOptionsResult"> <summary> Gets and sets the UpdateAvailabilityOptionsResult property. Represents the output of a UpdateAvailabilityOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest"> <summary> Container for the parameters to the UpdateDefaultSearchField operation. Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.DefaultSearchField"> <summary> Gets and sets the property DefaultSearchField. <para> 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 <code>q</code> parameter, or if a match expression specified with the <code>bq</code> parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields. </para> </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResponse"> <summary> Configuration for accessing Amazon UpdateDefaultSearchField service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResult"> <summary> A response message that contains the status of an updated default search field. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResult.DefaultSearchField"> <summary> Gets and sets the property DefaultSearchField. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateDefaultSearchFieldResponse.UpdateDefaultSearchFieldResult"> <summary> Gets and sets the UpdateDefaultSearchFieldResult property. Represents the output of a UpdateDefaultSearchField operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest"> <summary> Container for the parameters to the UpdateServiceAccessPolicies operation. Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResponse"> <summary> Configuration for accessing Amazon UpdateServiceAccessPolicies service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResult"> <summary> A response message that contains the status of updated access policies. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResult.AccessPolicies"> <summary> Gets and sets the property AccessPolicies. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateServiceAccessPoliciesResponse.UpdateServiceAccessPoliciesResult"> <summary> Gets and sets the UpdateServiceAccessPoliciesResult property. Represents the output of a UpdateServiceAccessPolicies operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest"> <summary> Container for the parameters to the UpdateStemmingOptions operation. Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsRequest.Stems"> <summary> Gets and sets the property Stems. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResponse"> <summary> Configuration for accessing Amazon UpdateStemmingOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResult"> <summary> A response message that contains the status of updated stemming options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResult.Stems"> <summary> Gets and sets the property Stems. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStemmingOptionsResponse.UpdateStemmingOptionsResult"> <summary> Gets and sets the UpdateStemmingOptionsResult property. Represents the output of a UpdateStemmingOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest"> <summary> Container for the parameters to the UpdateStopwordOptions operation. Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsRequest.Stopwords"> <summary> Gets and sets the property Stopwords. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResponse"> <summary> Configuration for accessing Amazon UpdateStopwordOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResult"> <summary> A response message that contains the status of updated stopword options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResult.Stopwords"> <summary> Gets and sets the property Stopwords. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateStopwordOptionsResponse.UpdateStopwordOptionsResult"> <summary> Gets and sets the UpdateStopwordOptionsResult property. Represents the output of a UpdateStopwordOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest"> <summary> Container for the parameters to the UpdateSynonymOptions operation. Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.DomainName"> <summary> Gets and sets the property DomainName. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsRequest.Synonyms"> <summary> Gets and sets the property Synonyms. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResponse"> <summary> Configuration for accessing Amazon UpdateSynonymOptions service </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResult"> <summary> A response message that contains the status of updated synonym options. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResult.Synonyms"> <summary> Gets and sets the property Synonyms. </summary> </member> <member name="P:Amazon.CloudSearch_2011_02_01.Model.UpdateSynonymOptionsResponse.UpdateSynonymOptionsResult"> <summary> Gets and sets the UpdateSynonymOptionsResult property. Represents the output of a UpdateSynonymOptions operation. </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.AccessPoliciesStatusUnmarshaller"> <summary> Response Unmarshaller for AccessPoliciesStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.AvailabilityOptionsStatusUnmarshaller"> <summary> Response Unmarshaller for AvailabilityOptionsStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.CreateDomainRequestMarshaller"> <summary> CreateDomain 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.DefaultSearchFieldStatusUnmarshaller"> <summary> Response Unmarshaller for DefaultSearchFieldStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DefineIndexFieldRequestMarshaller"> <summary> DefineIndexField 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.DefineRankExpressionRequestMarshaller"> <summary> DefineRankExpression 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.DeleteDomainRequestMarshaller"> <summary> DeleteDomain 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.DeleteIndexFieldRequestMarshaller"> <summary> DeleteIndexField 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.DeleteRankExpressionRequestMarshaller"> <summary> DeleteRankExpression 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.DescribeAvailabilityOptionsRequestMarshaller"> <summary> DescribeAvailabilityOptions Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeAvailabilityOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAvailabilityOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.DescribeDefaultSearchFieldRequestMarshaller"> <summary> DescribeDefaultSearchField 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.DescribeDomainsRequestMarshaller"> <summary> DescribeDomains 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.DescribeIndexFieldsRequestMarshaller"> <summary> DescribeIndexFields 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.DescribeRankExpressionsRequestMarshaller"> <summary> DescribeRankExpressions 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.DescribeServiceAccessPoliciesRequestMarshaller"> <summary> DescribeServiceAccessPolicies 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.DescribeStemmingOptionsRequestMarshaller"> <summary> DescribeStemmingOptions 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.DescribeStopwordOptionsRequestMarshaller"> <summary> DescribeStopwordOptions 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.DescribeSynonymOptionsRequestMarshaller"> <summary> DescribeSynonymOptions 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.DomainStatusUnmarshaller"> <summary> Response Unmarshaller for DomainStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexDocumentsRequestMarshaller"> <summary> IndexDocuments 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.IndexFieldStatusUnmarshaller"> <summary> Response Unmarshaller for IndexFieldStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.IndexFieldUnmarshaller"> <summary> Response Unmarshaller for IndexField Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.LiteralOptionsUnmarshaller"> <summary> Response Unmarshaller for LiteralOptions Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.NamedRankExpressionUnmarshaller"> <summary> Response Unmarshaller for NamedRankExpression Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.OptionStatusUnmarshaller"> <summary> Response Unmarshaller for OptionStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.RankExpressionStatusUnmarshaller"> <summary> Response Unmarshaller for RankExpressionStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.ServiceEndpointUnmarshaller"> <summary> Response Unmarshaller for ServiceEndpoint Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceAttributeUnmarshaller"> <summary> Response Unmarshaller for SourceAttribute Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataMapUnmarshaller"> <summary> Response Unmarshaller for SourceDataMap Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataTrimTitleUnmarshaller"> <summary> Response Unmarshaller for SourceDataTrimTitle Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SourceDataUnmarshaller"> <summary> Response Unmarshaller for SourceData Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.StemmingOptionsStatusUnmarshaller"> <summary> Response Unmarshaller for StemmingOptionsStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.StopwordOptionsStatusUnmarshaller"> <summary> Response Unmarshaller for StopwordOptionsStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.SynonymOptionsStatusUnmarshaller"> <summary> Response Unmarshaller for SynonymOptionsStatus Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.TextOptionsUnmarshaller"> <summary> Response Unmarshaller for TextOptions Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UIntOptionsUnmarshaller"> <summary> Response Unmarshaller for UIntOptions Object </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsRequestMarshaller"> <summary> UpdateAvailabilityOptions Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateAvailabilityOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateAvailabilityOptions operation </summary> </member> <member name="T:Amazon.CloudSearch_2011_02_01.Model.Internal.MarshallTransformations.UpdateDefaultSearchFieldRequestMarshaller"> <summary> UpdateDefaultSearchField 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.UpdateServiceAccessPoliciesRequestMarshaller"> <summary> UpdateServiceAccessPolicies 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.UpdateStemmingOptionsRequestMarshaller"> <summary> UpdateStemmingOptions 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.UpdateStopwordOptionsRequestMarshaller"> <summary> UpdateStopwordOptions 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.UpdateSynonymOptionsRequestMarshaller"> <summary> UpdateSynonymOptions 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.CloudSearchDomain.AmazonCloudSearchDomainClient"> <summary> Implementation for accessing CloudSearchDomain You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. <para> The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </para> <para> For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain"> <summary> Interface for accessing CloudSearchDomain You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents. <para> The endpoints for submitting <code>UploadDocuments</code>, <code>Search</code>, and <code>Suggest</code> requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint. </para> <para> For more information, see the <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide">Amazon CloudSearch Developer Guide</a>. </para> </summary> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.Search(Amazon.CloudSearchDomain.Model.SearchRequest)"> <summary> Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul> <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Search service method.</param> <returns>The response from the Search service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.BeginSearch(Amazon.CloudSearchDomain.Model.SearchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Search operation. </summary> <param name="request">Container for the necessary parameters to execute the Search operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearch operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.EndSearch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Search operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSearch.</param> <returns>Returns a SearchResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.Suggest(Amazon.CloudSearchDomain.Model.SuggestRequest)"> <summary> Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Suggest service method.</param> <returns>The response from the Suggest service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.BeginSuggest(Amazon.CloudSearchDomain.Model.SuggestRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Suggest operation. </summary> <param name="request">Container for the necessary parameters to execute the Suggest operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSuggest operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.EndSuggest(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Suggest operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSuggest.</param> <returns>Returns a SuggestResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.UploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest)"> <summary> Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments service method.</param> <returns>The response from the UploadDocuments service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.DocumentServiceException"> Information about any problems encountered while processing an upload request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.BeginUploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.IAmazonCloudSearchDomain.EndUploadDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadDocuments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadDocuments.</param> <returns>Returns a UploadDocumentsResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.Search(Amazon.CloudSearchDomain.Model.SearchRequest)"> <summary> Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul> <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Search service method.</param> <returns>The response from the Search service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.BeginSearch(Amazon.CloudSearchDomain.Model.SearchRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Search operation. </summary> <param name="request">Container for the necessary parameters to execute the Search operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSearch operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.EndSearch(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Search operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSearch.</param> <returns>Returns a SearchResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.Suggest(Amazon.CloudSearchDomain.Model.SuggestRequest)"> <summary> Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> <param name="request">Container for the necessary parameters to execute the Suggest service method.</param> <returns>The response from the Suggest service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.SearchException"> Information about any problems encountered while processing a search request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.BeginSuggest(Amazon.CloudSearchDomain.Model.SuggestRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Suggest operation. </summary> <param name="request">Container for the necessary parameters to execute the Suggest operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSuggest operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.EndSuggest(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Suggest operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSuggest.</param> <returns>Returns a SuggestResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.UploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest)"> <summary> Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments service method.</param> <returns>The response from the UploadDocuments service method, as returned by CloudSearchDomain.</returns> <exception cref="T:Amazon.CloudSearchDomain.Model.DocumentServiceException"> Information about any problems encountered while processing an upload request. </exception> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.BeginUploadDocuments(Amazon.CloudSearchDomain.Model.UploadDocumentsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadDocuments operation. </summary> <param name="request">Container for the necessary parameters to execute the UploadDocuments operation on AmazonCloudSearchDomainClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUploadDocuments operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.EndUploadDocuments(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadDocuments operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadDocuments.</param> <returns>Returns a UploadDocumentsResult from CloudSearchDomain.</returns> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Credentials </summary> <param name="serviceUrl">The URL of the search or document service.</param> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Credentials and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String,System.String)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="serviceUrl">The URL of the search or document service.</param> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient.#ctor(System.String,System.String,System.String,Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig)"> <summary> Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudSearchDomainClient Configuration Object</param> </member> <member name="T:Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig"> <summary> Configuration for accessing Amazon CloudSearchDomain service </summary> <summary> Configuration for accessing Amazon CloudSearchDomain service </summary> </member> <member name="M:Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudSearchDomain.AmazonCloudSearchDomainConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudSearchDomain.ContentType"> <summary> Constants used for properties of type ContentType. </summary> </member> <member name="F:Amazon.CloudSearchDomain.ContentType.ApplicationJson"> <summary> Constant ApplicationJson for ContentType </summary> </member> <member name="F:Amazon.CloudSearchDomain.ContentType.ApplicationXml"> <summary> Constant ApplicationXml for ContentType </summary> </member> <member name="M:Amazon.CloudSearchDomain.ContentType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearchDomain.ContentType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearchDomain.QueryParser"> <summary> Constants used for properties of type QueryParser. </summary> </member> <member name="F:Amazon.CloudSearchDomain.QueryParser.Dismax"> <summary> Constant Dismax for QueryParser </summary> </member> <member name="F:Amazon.CloudSearchDomain.QueryParser.Lucene"> <summary> Constant Lucene for QueryParser </summary> </member> <member name="F:Amazon.CloudSearchDomain.QueryParser.Simple"> <summary> Constant Simple for QueryParser </summary> </member> <member name="F:Amazon.CloudSearchDomain.QueryParser.Structured"> <summary> Constant Structured for QueryParser </summary> </member> <member name="M:Amazon.CloudSearchDomain.QueryParser.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudSearchDomain.QueryParser.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudSearchDomain.AmazonCloudSearchDomainRequest"> <summary> Base class for CloudSearchDomain operation requests. </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Bucket"> <summary> A container for facet information. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Bucket.Count"> <summary> Gets and sets the property Count. <para> The number of hits that contain the facet value in the specified facet field. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Bucket.Value"> <summary> Gets and sets the property Value. <para> The facet value being counted. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.BucketInfo"> <summary> A container for the calculated facet values and counts. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.BucketInfo.Buckets"> <summary> Gets and sets the property Buckets. <para> A list of the calculated facet values and counts. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.DocumentServiceException"> <summary> CloudSearchDomain exception </summary> </member> <member name="M:Amazon.CloudSearchDomain.Model.DocumentServiceException.#ctor(System.String)"> <summary> Constructs a new DocumentServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearchDomain.Model.DocumentServiceWarning"> <summary> A warning returned by the document service when an issue is discovered while processing an upload request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.DocumentServiceWarning.Message"> <summary> Gets and sets the property Message. <para> The description for a warning returned by the document service. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.FieldStats"> <summary> The statistics for a field calculated in the request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Count"> <summary> Gets and sets the property Count. <para> The number of documents that contain a value in the specified field in the result set. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Max"> <summary> Gets and sets the property Max. <para> The maximum value found in the specified field in the result set. </para> <para> If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>max</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>max</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Mean"> <summary> Gets and sets the property Mean. <para> The average of the values found in the specified field in the result set. </para> <para> If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>mean</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>mean</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Min"> <summary> Gets and sets the property Min. <para> The minimum value found in the specified field in the result set. </para> <para> If the field is numeric (<code>int</code>, <code>int-array</code>, <code>double</code>, or <code>double-array</code>), <code>min</code> is the string representation of a double-precision 64-bit floating point value. If the field is <code>date</code> or <code>date-array</code>, <code>min</code> is the string representation of a date with the format specified in <a href="http://tools.ietf.org/html/rfc3339">IETF RFC3339</a>: yyyy-mm-ddTHH:mm:ss.SSSZ. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Missing"> <summary> Gets and sets the property Missing. <para> The number of documents that do not contain a value in the specified field in the result set. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Stddev"> <summary> Gets and sets the property Stddev. <para> The standard deviation of the values in the specified field in the result set. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.Sum"> <summary> Gets and sets the property Sum. <para> The sum of the field values across the documents in the result set. <code>null</code> for date fields. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.FieldStats.SumOfSquares"> <summary> Gets and sets the property SumOfSquares. <para> The sum of all field values in the result set squared. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Hit"> <summary> Information about a document that matches the search request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hit.Exprs"> <summary> Gets and sets the property Exprs. <para> The expressions returned from a document that matches the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hit.Fields"> <summary> Gets and sets the property Fields. <para> The fields returned from a document that matches the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hit.Highlights"> <summary> Gets and sets the property Highlights. <para> The highlights returned from a document that matches the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hit.Id"> <summary> Gets and sets the property Id. <para> The document ID of a document that matches the search request. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Hits"> <summary> The collection of documents that match the search request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hits.Cursor"> <summary> Gets and sets the property Cursor. <para> A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hits.Found"> <summary> Gets and sets the property Found. <para> The total number of documents that match the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hits.Hit"> <summary> Gets and sets the property Hit. <para> A document that matches the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.Hits.Start"> <summary> Gets and sets the property Start. <para> The index of the first matching document. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SearchException"> <summary> CloudSearchDomain exception </summary> </member> <member name="M:Amazon.CloudSearchDomain.Model.SearchException.#ctor(System.String)"> <summary> Constructs a new SearchException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudSearchDomain.Model.SearchRequest"> <summary> Container for the parameters to the Search operation. Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers: <ul> <li><code>simple</code>: search all <code>text</code> and <code>text-array</code> fields for the specified string. Search for phrases, individual terms, and prefixes. </li> <li><code>structured</code>: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.</li> <li><code>lucene</code>: specify search criteria using the Apache Lucene query parser syntax.</li> <li><code>dismax</code>: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.</li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Search</code> requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Cursor"> <summary> Gets and sets the property Cursor. <para> Retrieves a cursor value you can use to page through large result sets. Use the <code>size</code> parameter to control the number of hits to include in each response. You can specify either the <code>cursor</code> or <code>start</code> parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to <code>initial</code>. In subsequent requests, specify the cursor value returned in the hits section of the response. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Expr"> <summary> Gets and sets the property Expr. <para> Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields. </para> <para> You specify the expressions in JSON using the form <code>{"EXPRESSIONNAME":"EXPRESSION"}</code>. You can define and use multiple expressions in a search request. For example: </para> <para> <code> {"expression1":"_score*rating", "expression2":"(1/rank)*year"} </code> </para> <para> For information about the variables, operators, and functions you can use in expressions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html#writing-expressions">Writing Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Facet"> <summary> Gets and sets the property Facet. <para> Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. </para> <para> You can specify the following faceting options: </para> <ul> <li> <para> <code>buckets</code> specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-ranges.html"> Searching for a Range of Values</a> in the <i>Amazon CloudSearch Developer Guide</i>. Buckets are returned in the order they are specified in the request. The <code>sort</code> and <code>size</code> options are not valid if you specify <code>buckets</code>. </para> </li> <li> <para> <code>size</code> specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The <code>size</code> parameter is only valid when you specify the <code>sort</code> option; it cannot be used in conjunction with <code>buckets</code>. </para> </li> <li> <para> <code>sort</code> specifies how you want to sort the facets in the results: <code>bucket</code> or <code>count</code>. Specify <code>bucket</code> to sort alphabetically or numerically by facet value (in ascending order). Specify <code>count</code> to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the <code>buckets</code> option instead of <code>sort</code>. </para> </li> </ul> <para> If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results. </para> <para> To count particular buckets of values, use the <code>buckets</code> option. For example, the following request uses the <code>buckets</code> option to calculate and return facet counts by decade. </para> <para> <code> {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} </code> </para> <para> To sort facets by facet count, use the <code>count</code> option. For example, the following request sets the <code>sort</code> option to <code>count</code> to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the <code>size</code> option to 3 returns only the top three facet values. </para> <para> <code> {"year":{"sort":"count","size":3}} </code> </para> <para> To sort the facets by value, use the <code>bucket</code> option. For example, the following request sets the <code>sort</code> option to <code>bucket</code> to sort the facet values numerically by year, with earliest year listed first. </para> <para> <code> {"year":{"sort":"bucket"}} </code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/faceting.html">Getting and Using Facet Information</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.FilterQuery"> <summary> Gets and sets the property FilterQuery. <para> Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use <code>filterQuery</code> in conjunction with the <code>query</code> parameter to filter the documents that match the constraints specified in the <code>query</code> parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The <code>filterQuery</code> parameter supports the full structured query syntax. </para> <para> For more information about using filters, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/filtering-results.html">Filtering Matching Documents</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Highlight"> <summary> Gets and sets the property Highlight. <para> Retrieves highlights for matches in the specified <code>text</code> or <code>text-array</code> fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form <code>{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}</code>. </para> <para> You can specify the following highlight options: </para> <ul> <li> <code>format</code>: specifies the format of the data in the text field: <code>text</code> or <code>html</code>. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is <code>html</code>. </li> <li> <code>max_phrases</code>: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted. </li> <li> <code>pre_tag</code>: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is <code>&lt;em&gt;</code>. The default for text highlights is <code>*</code>. </li> <li> <code>post_tag</code>: specifies the string to append to an occurrence of a search term. The default for HTML highlights is <code>&lt;/em&gt;</code>. The default for text highlights is <code>*</code>. </li> </ul> <para> If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: <code>&lt;em>search-term&lt;/em&gt;</code>. </para> <para> For example, the following request retrieves highlights for the <code>actors</code> and <code>title</code> fields. </para> <para> <code>{ "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "<b>","post_tag": "</b>"} }</code> </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Partial"> <summary> Gets and sets the property Partial. <para> Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Query"> <summary> Gets and sets the property Query. <para> Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the <code>queryOptions</code> parameter. By default, the <code>simple</code> query parser is used to process requests. To use the <code>structured</code>, <code>lucene</code>, or <code>dismax</code> query parser, you must also specify the <code>queryParser</code> parameter. </para> <para> For more information about specifying search criteria, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching.html">Searching Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.QueryOptions"> <summary> Gets and sets the property QueryOptions. <para> Configures options for the query parser specified in the <code>queryParser</code> parameter. You specify the options in JSON using the following form <code>{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.</code> </para> <para> The options you can configure vary according to which parser you use: </para> <ul> <li><code>defaultOperator</code>: The default operator used to combine individual terms in the search string. For example: <code>defaultOperator: 'or'</code>. For the <code>dismax</code> parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of <code>0%</code> is the equivalent to OR, and a value of <code>100%</code> is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, <code>defaultOperator: 50%</code>. Valid values: <code>and</code>, <code>or</code>, a percentage in the range 0%-100% (<code>dismax</code>). Default: <code>and</code> (<code>simple</code>, <code>structured</code>, <code>lucene</code>) or <code>100</code> (<code>dismax</code>). Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li><code>fields</code>: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost the importance of the <code>title</code> field over the <code>description</code> field you could specify: <code>"fields":["title^5","description"]</code>. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All <code>text</code> and <code>text-array</code> fields. Valid for: <code>simple</code>, <code>structured</code>, <code>lucene</code>, and <code>dismax</code>.</li> <li><code>operators</code>: An array of the operators or special characters you want to disable for the simple query parser. If you disable the <code>and</code>, <code>or</code>, or <code>not</code> operators, the corresponding operators (<code>+</code>, <code>|</code>, <code>-</code>) have no special meaning and are dropped from the search string. Similarly, disabling <code>prefix</code> disables the wildcard operator (<code>*</code>) and disabling <code>phrase</code> disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling <code>near</code> disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the <code>fuzzy</code> operator disables the ability to use the ~ operator to perform a fuzzy search. <code>escape</code> disables the ability to use a backslash (<code>\</code>) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: <code>"operators":["and","not","or", "prefix"]</code>. Valid values: <code>and</code>, <code>escape</code>, <code>fuzzy</code>, <code>near</code>, <code>not</code>, <code>or</code>, <code>phrase</code>, <code>precedence</code>, <code>prefix</code>, <code>whitespace</code>. Default: All operators and special characters are enabled. Valid for: <code>simple</code>.</li> <li><code>phraseFields</code>: An array of the <code>text</code> or <code>text-array</code> fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The <code>phraseSlop</code> option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (<code>^</code>) symbol and the weight to the field name. For example, to boost phrase matches in the <code>title</code> field over the <code>abstract</code> field, you could specify: <code>"phraseFields":["title^3", "plot"]</code> Valid values: The name of any <code>text</code> or <code>text-array</code> field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with <code>phraseFields</code>, proximity scoring is disabled even if <code>phraseSlop</code> is specified. Valid for: <code>dismax</code>.</li> <li><code>phraseSlop</code>: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the <code>phraseFields</code> option; for example, <code>phraseSlop: 2</code>. You must also specify <code>phraseFields</code> to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li><code>explicitPhraseSlop</code>: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify <code>"explicitPhraseSlop":3</code>. Valid values: positive integers. Default: 0. Valid for: <code>dismax</code>.</li> <li><code>tieBreaker</code>: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a <code>tieBreaker</code> value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is <code>(max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields)</code>. Set <code>tieBreaker</code> to 0 to disregard all but the highest scoring field (pure max): <code>"tieBreaker":0</code>. Set to 1 to sum the scores from all fields (pure sum): <code>"tieBreaker":1</code>. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: <code>dismax</code>. </li> </ul> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.QueryParser"> <summary> Gets and sets the property QueryParser. <para> Specifies which query parser to use to process the request. If <code>queryParser</code> is not specified, Amazon CloudSearch uses the <code>simple</code> query parser. </para> <para> Amazon CloudSearch supports four query parsers: </para> <ul> <li> <code>simple</code>: perform simple searches of <code>text</code> and <code>text-array</code> fields. By default, the <code>simple</code> query parser searches all <code>text</code> and <code>text-array</code> fields. You can specify which fields to search by with the <code>queryOptions</code> parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the <code>queryOptions</code> parameter.) You can use the <code>-</code> (NOT), <code>|</code> (OR), and <code>*</code> (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-text.html">Searching for Text</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li> <li> <code>structured</code>: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, <code>matchall</code>, and <code>near</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/searching-compound-queries.html">Constructing Compound Queries</a> in the <i>Amazon CloudSearch Developer Guide</i>. </li> <li> <code>lucene</code>: search using the Apache Lucene query parser syntax. For more information, see <a href="http://lucene.apache.org/core/4_6_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Apache Lucene Query Parser Syntax</a>. </li> <li> <code>dismax</code>: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see <a href="http://wiki.apache.org/solr/DisMaxQParserPlugin#Query_Syntax">DisMax Query Parser Syntax</a>. </li> </ul> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Return"> <summary> Gets and sets the property Return. <para> Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (<code>_all_fields</code>). To return only the document IDs for the matching documents, specify <code>_no_fields</code>. To retrieve the relevance score calculated for each document, specify <code>_score</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Size"> <summary> Gets and sets the property Size. <para> Specifies the maximum number of search hits to include in the response. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Sort"> <summary> Gets and sets the property Sort. <para> Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (<code>asc</code> or <code>desc</code>) for each field; for example, <code>year desc,title asc</code>. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no <code>sort</code> parameter is specified, results are sorted by their default relevance scores in descending order: <code>_score desc</code>. You can also sort by document ID (<code>_id asc</code>) and version (<code>_version desc</code>). </para> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/sorting-results.html">Sorting Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Start"> <summary> Gets and sets the property Start. <para> Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the <code>start</code> or <code>cursor</code> parameter in a request, they are mutually exclusive. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/paginating-results.html">Paginating Results</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchRequest.Stats"> <summary> Gets and sets the property Stats. <para> Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form: </para> <code>{"FIELD-A":{},"FIELD-B":{}}</code> <para> There are currently no options supported for statistics. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SearchResponse"> <summary> Configuration for accessing Amazon Search service </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SearchResult"> <summary> The result of a <code>Search</code> request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchResult.Facets"> <summary> Gets and sets the property Facets. <para> The requested facet information. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchResult.Hits"> <summary> Gets and sets the property Hits. <para> The documents that match the search criteria. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchResult.Stats"> <summary> Gets and sets the property Stats. <para> The requested field statistics information. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchResult.Status"> <summary> Gets and sets the property Status. <para> The status information returned for the search request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchResponse.SearchResult"> <summary> Gets and sets the SearchResult property. Represents the output of a Search operation. </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SearchStatus"> <summary> Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>). </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchStatus.Rid"> <summary> Gets and sets the property Rid. <para> The encrypted resource ID for the request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SearchStatus.Timems"> <summary> Gets and sets the property Timems. <para> How long it took to process the request, in milliseconds. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestionMatch"> <summary> An autocomplete suggestion that matches the query string specified in a <code>SuggestRequest</code>. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestionMatch.Id"> <summary> Gets and sets the property Id. <para> The document ID of the suggested document. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestionMatch.Score"> <summary> Gets and sets the property Score. <para> The relevance score of a suggested match. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestionMatch.Suggestion"> <summary> Gets and sets the property Suggestion. <para> The string that matches the query string specified in the <code>SuggestRequest</code>. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestModel"> <summary> Container for the suggestion information returned in a <code>SuggestResponse</code>. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestModel.Found"> <summary> Gets and sets the property Found. <para> The number of documents that were found to match the query string. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestModel.Query"> <summary> Gets and sets the property Query. <para> The query string specified in the suggest request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestModel.Suggestions"> <summary> Gets and sets the property Suggestions. <para> The documents that match the query string. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestRequest"> <summary> Container for the parameters to the Suggest operation. Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match. <para> For more information about configuring suggesters and retrieving suggestions, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html">Getting Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> <para> The endpoint for submitting <code>Suggest</code> requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestRequest.Query"> <summary> Gets and sets the property Query. <para> Specifies the string for which you want to get suggestions. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestRequest.Size"> <summary> Gets and sets the property Size. <para> Specifies the maximum number of suggestions to return. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestRequest.Suggester"> <summary> Gets and sets the property Suggester. <para> Specifies the name of the suggester to use to find suggested matches. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestResponse"> <summary> Configuration for accessing Amazon Suggest service </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestResult"> <summary> Contains the response to a <code>Suggest</code> request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestResult.Status"> <summary> Gets and sets the property Status. <para> The status of a <code>SuggestRequest</code>. Contains the resource ID (<code>rid</code>) and how long it took to process the request (<code>timems</code>). </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestResult.Suggest"> <summary> Gets and sets the property Suggest. <para> Container for the matching search suggestion information. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestResponse.SuggestResult"> <summary> Gets and sets the SuggestResult property. Represents the output of a Suggest operation. </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.SuggestStatus"> <summary> Contains the resource id (<code>rid</code>) and the time it took to process the request (<code>timems</code>). </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestStatus.Rid"> <summary> Gets and sets the property Rid. <para> The encrypted resource ID for the request. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.SuggestStatus.Timems"> <summary> Gets and sets the property Timems. <para> How long it took to process the request, in milliseconds. </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.UploadDocumentsRequest"> <summary> Container for the parameters to the UploadDocuments operation. Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> <summary> Container for the parameters to the UploadDocuments operation. Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service. <para> The endpoint for submitting <code>UploadDocuments</code> requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service <code>DescribeDomains</code> action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. </para> <para> For more information about formatting your data for Amazon CloudSearch, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/preparing-data.html">Preparing Your Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. For more information about uploading data for indexing, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/uploading-data.html">Uploading Data</a> in the <i>Amazon CloudSearch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsRequest.ContentType"> <summary> Gets and sets the property ContentType. <para> The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: </para> <ul> <li>application/json</li> <li>application/xml</li> </ul> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsRequest.Documents"> <summary> Gets and sets the property Documents. <para> A batch of documents formatted in JSON or HTML. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsRequest.FilePath"> <summary> <para> The full path and name to a file that contains a batch of documents to be uploaded. The batch of documents should be formatted in JSON or HTML. If this property is set, the UploadDocumentsRequest.Documents property is ignored. </para> <para> For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt". </para> </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.UploadDocumentsResponse"> <summary> Configuration for accessing Amazon UploadDocuments service </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.UploadDocumentsResult"> <summary> Contains the response to an <code>UploadDocuments</code> request. </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsResult.Adds"> <summary> Gets and sets the property Adds. <para> The number of documents that were added to the search domain. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsResult.Deletes"> <summary> Gets and sets the property Deletes. <para> The number of documents that were deleted from the search domain. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsResult.Status"> <summary> Gets and sets the property Status. <para> The status of an <code>UploadDocumentsRequest</code>. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsResult.Warnings"> <summary> Gets and sets the property Warnings. <para> Any warnings returned by the document service about the documents being uploaded. </para> </summary> </member> <member name="P:Amazon.CloudSearchDomain.Model.UploadDocumentsResponse.UploadDocumentsResult"> <summary> Gets and sets the UploadDocumentsResult property. Represents the output of a UploadDocuments operation. </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.BucketInfoUnmarshaller"> <summary> Response Unmarshaller for BucketInfo Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.BucketUnmarshaller"> <summary> Response Unmarshaller for Bucket Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.DocumentServiceWarningUnmarshaller"> <summary> Response Unmarshaller for DocumentServiceWarning Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.FieldStatsUnmarshaller"> <summary> Response Unmarshaller for FieldStats Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.HitsUnmarshaller"> <summary> Response Unmarshaller for Hits Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.HitUnmarshaller"> <summary> Response Unmarshaller for Hit Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SearchRequestMarshaller"> <summary> Search Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SearchResponseUnmarshaller"> <summary> Response Unmarshaller for Search operation </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SearchStatusUnmarshaller"> <summary> Response Unmarshaller for SearchStatus Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SuggestionMatchUnmarshaller"> <summary> Response Unmarshaller for SuggestionMatch Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SuggestModelUnmarshaller"> <summary> Response Unmarshaller for SuggestModel Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SuggestRequestMarshaller"> <summary> Suggest Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SuggestResponseUnmarshaller"> <summary> Response Unmarshaller for Suggest operation </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.SuggestStatusUnmarshaller"> <summary> Response Unmarshaller for SuggestStatus Object </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.UploadDocumentsRequestMarshaller"> <summary> UploadDocuments Request Marshaller </summary> </member> <member name="T:Amazon.CloudSearchDomain.Model.Internal.MarshallTransformations.UploadDocumentsResponseUnmarshaller"> <summary> Response Unmarshaller for UploadDocuments operation </summary> </member> <member name="M:Amazon.CloudSearchDomain.Internal.ProcessRequestHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.CloudSearchDomain.Internal.ProcessRequestHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="M:Amazon.CloudSearchDomain.Internal.ValidationResponseHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls the post invoke logic after calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.CloudSearchDomain.Internal.ValidationResponseHandler.InvokeAsyncCallback(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls the PostInvoke methods after calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailClient"> <summary> Implementation for accessing CloudTrail AWS CloudTrail <para> This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail. </para> <para> CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files. </para> </summary> </member> <member name="T:Amazon.CloudTrail.IAmazonCloudTrail"> <summary> Interface for accessing CloudTrail AWS CloudTrail <para> This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail. </para> <para> CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service. </para> <note> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </note> <para> See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files. </para> </summary> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.AddTags(Amazon.CloudTrail.Model.AddTagsRequest)"> <summary> Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.TagsLimitExceededException"> The number of tags per trail has exceeded the permitted amount. Currently, the limit is 10. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginAddTags(Amazon.CloudTrail.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudTrail.IAmazonCloudTrail.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail service method.</param> <returns>The response from the CreateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> This exception is thrown when the maximum number of trails is reached. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> This exception is thrown when the specified trail already exists. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginCreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndCreateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTrail operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrail.</param> <returns>Returns a CreateTrailResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail service method.</param> <returns>The response from the DeleteTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginDeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndDeleteTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTrail operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrail.</param> <returns>Returns a DeleteTrailResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DescribeTrails"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails service method.</param> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginDescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndDescribeTrails(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrails operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrails.</param> <returns>Returns a DescribeTrailsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus service method.</param> <returns>The response from the GetTrailStatus service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginGetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndGetTrailStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTrailStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTrailStatus.</param> <returns>Returns a GetTrailStatusResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest)"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys service method.</param> <returns>The response from the ListPublicKeys service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPublicKeys operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.EndListPublicKeys(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPublicKeys operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPublicKeys.</param> <returns>Returns a ListPublicKeysResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.ListTags(Amazon.CloudTrail.Model.ListTagsRequest)"> <summary> Lists the tags for the specified trail or trails in the current region. <para> Lists the tags for the trail in the current region. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTags service method.</param> <returns>The response from the ListTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginListTags(Amazon.CloudTrail.Model.ListTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTags operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTags operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.EndListTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTags.</param> <returns>Returns a ListTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.LookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest)"> <summary> Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents service method.</param> <returns>The response from the LookupEvents service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidLookupAttributesException"> Occurs when an invalid lookup attribute is specified. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidMaxResultsException"> This exception is thrown if the limit specified is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidNextTokenException"> Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginLookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the LookupEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLookupEvents operation.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.EndLookupEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the LookupEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLookupEvents.</param> <returns>Returns a LookupEventsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.RemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest)"> <summary> Removes the specified tags from a trail. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginRemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudTrail.IAmazonCloudTrail.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging service method.</param> <returns>The response from the StartLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginStartLogging(Amazon.CloudTrail.Model.StartLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndStartLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartLogging operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartLogging.</param> <returns>Returns a StartLoggingResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging service method.</param> <returns>The response from the StopLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginStopLogging(Amazon.CloudTrail.Model.StopLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndStopLogging(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopLogging operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopLogging.</param> <returns>Returns a StopLoggingResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail service method.</param> <returns>The response from the UpdateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.IAmazonCloudTrail.BeginUpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudTrail.EndUpdateTrail(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTrail operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTrail.</param> <returns>Returns a UpdateTrailResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Credentials and an AmazonCloudTrailClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.#ctor(System.String,System.String,System.String,Amazon.CloudTrail.AmazonCloudTrailConfig)"> <summary> Constructs AmazonCloudTrailClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudTrailClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudTrailClient Configuration Object</param> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.AddTags(Amazon.CloudTrail.Model.AddTagsRequest)"> <summary> Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.TagsLimitExceededException"> The number of tags per trail has exceeded the permitted amount. Currently, the limit is 10. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginAddTags(Amazon.CloudTrail.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudTrail.AmazonCloudTrailClient.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.CreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest)"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail service method.</param> <returns>The response from the CreateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> This exception is thrown when the maximum number of trails is reached. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> This exception is thrown when the specified trail already exists. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginCreateTrail(Amazon.CloudTrail.Model.CreateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrail.</param> <returns>Returns a CreateTrailResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest)"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail service method.</param> <returns>The response from the DeleteTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginDeleteTrail(Amazon.CloudTrail.Model.DeleteTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrail.</param> <returns>Returns a DeleteTrailResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.DescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest)"> <summary> Retrieves settings for the trail associated with the current region for your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails service method.</param> <returns>The response from the DescribeTrails service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginDescribeTrails(Amazon.CloudTrail.Model.DescribeTrailsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrails operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrails operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrails.</param> <returns>Returns a DescribeTrailsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.GetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest)"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus service method.</param> <returns>The response from the GetTrailStatus service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginGetTrailStatus(Amazon.CloudTrail.Model.GetTrailStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTrailStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTrailStatus operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTrailStatus.</param> <returns>Returns a GetTrailStatusResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest)"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys service method.</param> <returns>The response from the ListPublicKeys service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginListPublicKeys(Amazon.CloudTrail.Model.ListPublicKeysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPublicKeys operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPublicKeys operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListPublicKeys operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndListPublicKeys(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPublicKeys operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPublicKeys.</param> <returns>Returns a ListPublicKeysResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.ListTags(Amazon.CloudTrail.Model.ListTagsRequest)"> <summary> Lists the tags for the specified trail or trails in the current region. <para> Lists the tags for the trail in the current region. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListTags service method.</param> <returns>The response from the ListTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTokenException"> Reserved for future use. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginListTags(Amazon.CloudTrail.Model.ListTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTags operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTags operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndListTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTags.</param> <returns>Returns a ListTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.LookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest)"> <summary> Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents service method.</param> <returns>The response from the LookupEvents service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidLookupAttributesException"> Occurs when an invalid lookup attribute is specified. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidMaxResultsException"> This exception is thrown if the limit specified is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidNextTokenException"> Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginLookupEvents(Amazon.CloudTrail.Model.LookupEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the LookupEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the LookupEvents operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndLookupEvents operation.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.EndLookupEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the LookupEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginLookupEvents.</param> <returns>Returns a LookupEventsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.RemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest)"> <summary> Removes the specified tags from a trail. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTagParameterException"> This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$</code>. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> This exception is thrown when the specified resource is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> This exception is thrown when the specified resource type is not supported by CloudTrail. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginRemoveTags(Amazon.CloudTrail.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.CloudTrail.AmazonCloudTrailClient.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StartLogging(Amazon.CloudTrail.Model.StartLoggingRequest)"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging service method.</param> <returns>The response from the StartLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginStartLogging(Amazon.CloudTrail.Model.StartLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StartLogging operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartLogging.</param> <returns>Returns a StartLoggingResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.StopLogging(Amazon.CloudTrail.Model.StopLoggingRequest)"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging service method.</param> <returns>The response from the StopLogging service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginStopLogging(Amazon.CloudTrail.Model.StopLoggingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopLogging operation. </summary> <param name="request">Container for the necessary parameters to execute the StopLogging operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopLogging.</param> <returns>Returns a StopLoggingResult from CloudTrail.</returns> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.UpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest)"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail service method.</param> <returns>The response from the UpdateTrail service method, as returned by CloudTrail.</returns> <exception cref="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> Cannot set a CloudWatch Logs delivery for this region. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> This exception is thrown when the policy on the S3 bucket is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InsufficientSnsTopicPolicyException"> This exception is thrown when the policy on the SNS topic is not sufficient. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException"> This exception is thrown when the provided CloudWatch log group is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> This exception is thrown when the provided role is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> This exception is thrown when the KMS key ARN is invalid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidParameterCombinationException"> This exception is thrown when the combination of parameters provided is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3BucketNameException"> This exception is thrown when the provided S3 bucket name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidS3PrefixException"> This exception is thrown when the provided S3 prefix is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidSnsTopicNameException"> This exception is thrown when the provided SNS topic name is not valid. </exception> <exception cref="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyDisabledException"> This exception is thrown when the KMS key is disabled. </exception> <exception cref="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region. </exception> <exception cref="T:Amazon.CloudTrail.Model.OperationNotPermittedException"> This exception is thrown when the requested operation is not permitted. </exception> <exception cref="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> This exception is thrown when the specified S3 bucket does not exist. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotFoundException"> This exception is thrown when the trail with the given name is not found. </exception> <exception cref="T:Amazon.CloudTrail.Model.TrailNotProvidedException"> This exception is deprecated. </exception> <exception cref="T:Amazon.CloudTrail.Model.UnsupportedOperationException"> This exception is thrown when the requested operation is not supported. </exception> </member> <member name="M:Amazon.CloudTrail.AmazonCloudTrailClient.BeginUpdateTrail(Amazon.CloudTrail.Model.UpdateTrailRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTrail operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTrail operation on AmazonCloudTrailClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTrail.</param> <returns>Returns a UpdateTrailResult from CloudTrail.</returns> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailConfig"> <summary> Configuration for accessing Amazon CloudTrail 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.LookupAttributeKey"> <summary> Constants used for properties of type LookupAttributeKey. </summary> </member> <member name="F:Amazon.CloudTrail.LookupAttributeKey.EventId"> <summary> Constant EventId for LookupAttributeKey </summary> </member> <member name="F:Amazon.CloudTrail.LookupAttributeKey.EventName"> <summary> Constant EventName for LookupAttributeKey </summary> </member> <member name="F:Amazon.CloudTrail.LookupAttributeKey.ResourceName"> <summary> Constant ResourceName for LookupAttributeKey </summary> </member> <member name="F:Amazon.CloudTrail.LookupAttributeKey.ResourceType"> <summary> Constant ResourceType for LookupAttributeKey </summary> </member> <member name="F:Amazon.CloudTrail.LookupAttributeKey.Username"> <summary> Constant Username for LookupAttributeKey </summary> </member> <member name="M:Amazon.CloudTrail.LookupAttributeKey.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudTrail.LookupAttributeKey.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudTrail.Model.AddTagsRequest"> <summary> Container for the parameters to the AddTags operation. Adds one or more tags to a trail, up to a limit of 10. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region). </summary> </member> <member name="T:Amazon.CloudTrail.AmazonCloudTrailRequest"> <summary> Base class for CloudTrail operation requests. </summary> </member> <member name="P:Amazon.CloudTrail.Model.AddTagsRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.AddTagsRequest.TagsList"> <summary> Gets and sets the property TagsList. <para> Contains a list of CloudTrail tags, up to a limit of 10. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.AddTagsResponse"> <summary> Configuration for accessing Amazon AddTags service </summary> </member> <member name="T:Amazon.CloudTrail.Model.AddTagsResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.AddTagsResponse.AddTagsResult"> <summary> Gets and sets the AddTagsResult property. Represents the output of a AddTags operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.CloudTrailARNInvalidException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.CloudTrailARNInvalidException.#ctor(System.String)"> <summary> Constructs a new CloudTrailARNInvalidException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.CloudWatchLogsDeliveryUnavailableException.#ctor(System.String)"> <summary> Constructs a new CloudWatchLogsDeliveryUnavailableException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailRequest"> <summary> Container for the parameters to the CreateTrail operation. Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created. </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.CloudWatchLogsLogGroupArn"> <summary> Gets and sets the property CloudWatchLogsLogGroupArn. <para> Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.CloudWatchLogsRoleArn"> <summary> Gets and sets the property CloudWatchLogsRoleArn. <para> Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.EnableLogFileValidation"> <summary> Gets and sets the property EnableLogFileValidation. <para> Specifies whether log file integrity validation is enabled. The default is false. </para> <note>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.IncludeGlobalServiceEvents"> <summary> Gets and sets the property IncludeGlobalServiceEvents. <para> Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.IsMultiRegionTrail"> <summary> Gets and sets the property IsMultiRegionTrail. <para> Specifies whether the trail is created in the current region or in all regions. The default is false. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. </para> <para> Examples: </para> <ul> <li>alias/MyAliasName</li> <li>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>12345678-1234-1234-1234-123456789012</li> </ul> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name of the trail. The name must meet the following requirements: </para> <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailRequest.SnsTopicName"> <summary> Gets and sets the property SnsTopicName. <para> Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailResponse"> <summary> Configuration for accessing Amazon CreateTrail service </summary> </member> <member name="T:Amazon.CloudTrail.Model.CreateTrailResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.CloudWatchLogsLogGroupArn"> <summary> Gets and sets the property CloudWatchLogsLogGroupArn. <para> Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.CloudWatchLogsRoleArn"> <summary> Gets and sets the property CloudWatchLogsRoleArn. <para> Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.IncludeGlobalServiceEvents"> <summary> Gets and sets the property IncludeGlobalServiceEvents. <para> Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.IsMultiRegionTrail"> <summary> Gets and sets the property IsMultiRegionTrail. <para> Specifies whether the trail exists in one region or in all regions. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: </para> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.LogFileValidationEnabled"> <summary> Gets and sets the property LogFileValidationEnabled. <para> Specifies whether log file integrity validation is enabled. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.Name"> <summary> Gets and sets the property Name. <para> Specifies the name of the trail. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> Specifies the name of the Amazon S3 bucket designated for publishing log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.SnsTopicName"> <summary> Gets and sets the property SnsTopicName. <para> Specifies the name of the Amazon SNS topic defined for notification of log file delivery. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResult.TrailARN"> <summary> Gets and sets the property TrailARN. <para> Specifies the ARN of the trail that was created. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.CreateTrailResponse.CreateTrailResult"> <summary> Gets and sets the CreateTrailResult property. Represents the output of a CreateTrail operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailRequest"> <summary> Container for the parameters to the DeleteTrail operation. Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DeleteTrailRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailResponse"> <summary> Configuration for accessing Amazon DeleteTrail service </summary> </member> <member name="T:Amazon.CloudTrail.Model.DeleteTrailResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DeleteTrailResponse.DeleteTrailResult"> <summary> Gets and sets the DeleteTrailResult property. Represents the output of a DeleteTrail operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsRequest"> <summary> Container for the parameters to the DescribeTrails operation. Retrieves settings for the trail associated with the current region for your account. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsRequest.IncludeShadowTrails"> <summary> Gets and sets the property IncludeShadowTrails. <para> Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsRequest.TrailNameList"> <summary> Gets and sets the property TrailNameList. <para> Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. If an empty list is specified, information for the trail in the current region is returned. </para> <ul> <li>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then information for all trails in the current region is returned.</li> <li> If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned. </li> </ul> <note>If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.</note> </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsResponse"> <summary> Configuration for accessing Amazon DescribeTrails service </summary> </member> <member name="T:Amazon.CloudTrail.Model.DescribeTrailsResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsResult.TrailList"> <summary> Gets and sets the property TrailList. <para> The list of trail objects. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.DescribeTrailsResponse.DescribeTrailsResult"> <summary> Gets and sets the DescribeTrailsResult property. Represents the output of a DescribeTrails operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.Event"> <summary> Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.CloudTrailEvent"> <summary> Gets and sets the property CloudTrailEvent. <para> A JSON string that contains a representation of the event returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.EventId"> <summary> Gets and sets the property EventId. <para> The CloudTrail ID of the event returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.EventName"> <summary> Gets and sets the property EventName. <para> The name of the event returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.EventTime"> <summary> Gets and sets the property EventTime. <para> The date and time of the event returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.Resources"> <summary> Gets and sets the property Resources. <para> A list of resources referenced by the event returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Event.Username"> <summary> Gets and sets the property Username. <para> A user name or role name of the requester that called the API in the event returned. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusRequest"> <summary> Container for the parameters to the GetTrailStatus operation. Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusResponse"> <summary> Configuration for accessing Amazon GetTrailStatus service </summary> </member> <member name="T:Amazon.CloudTrail.Model.GetTrailStatusResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.IsLogging"> <summary> Gets and sets the property IsLogging. <para> Whether the CloudTrail is currently logging AWS API calls. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestCloudWatchLogsDeliveryError"> <summary> Gets and sets the property LatestCloudWatchLogsDeliveryError. <para> Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestCloudWatchLogsDeliveryTime"> <summary> Gets and sets the property LatestCloudWatchLogsDeliveryTime. <para> Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryAttemptSucceeded"> <summary> Gets and sets the property LatestDeliveryAttemptSucceeded. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryAttemptTime"> <summary> Gets and sets the property LatestDeliveryAttemptTime. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryError"> <summary> Gets and sets the property LatestDeliveryError. <para> Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error Responses</a> in the Amazon S3 API Reference. </para> <note>This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call <code>UpdateTrail</code> to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket. </note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDeliveryTime"> <summary> Gets and sets the property LatestDeliveryTime. <para> Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDigestDeliveryError"> <summary> Gets and sets the property LatestDigestDeliveryError. <para> Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html">Error Responses</a> in the Amazon S3 API Reference. </para> <note>This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call <code>UpdateTrail</code> to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket. </note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestDigestDeliveryTime"> <summary> Gets and sets the property LatestDigestDeliveryTime. <para> Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationAttemptSucceeded"> <summary> Gets and sets the property LatestNotificationAttemptSucceeded. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationAttemptTime"> <summary> Gets and sets the property LatestNotificationAttemptTime. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationError"> <summary> Gets and sets the property LatestNotificationError. <para> Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the <a href="http://docs.aws.amazon.com/sns/latest/dg/welcome.html">Amazon SNS Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.LatestNotificationTime"> <summary> Gets and sets the property LatestNotificationTime. <para> Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.StartLoggingTime"> <summary> Gets and sets the property StartLoggingTime. <para> Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.StopLoggingTime"> <summary> Gets and sets the property StopLoggingTime. <para> Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.TimeLoggingStarted"> <summary> Gets and sets the property TimeLoggingStarted. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResult.TimeLoggingStopped"> <summary> Gets and sets the property TimeLoggingStopped. <para> This field is deprecated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.GetTrailStatusResponse.GetTrailStatusResult"> <summary> Gets and sets the GetTrailStatusResult property. Represents the output of a GetTrailStatus operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InsufficientEncryptionPolicyException.#ctor(System.String)"> <summary> Constructs a new InsufficientEncryptionPolicyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InsufficientS3BucketPolicyException"> <summary> CloudTrail 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> CloudTrail 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.InvalidCloudWatchLogsLogGroupArnException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidCloudWatchLogsLogGroupArnException.#ctor(System.String)"> <summary> Constructs a new InvalidCloudWatchLogsLogGroupArnException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidCloudWatchLogsRoleArnException.#ctor(System.String)"> <summary> Constructs a new InvalidCloudWatchLogsRoleArnException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidHomeRegionException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidHomeRegionException.#ctor(System.String)"> <summary> Constructs a new InvalidHomeRegionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidKmsKeyIdException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidKmsKeyIdException.#ctor(System.String)"> <summary> Constructs a new InvalidKmsKeyIdException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidLookupAttributesException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidLookupAttributesException.#ctor(System.String)"> <summary> Constructs a new InvalidLookupAttributesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidMaxResultsException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidMaxResultsException.#ctor(System.String)"> <summary> Constructs a new InvalidMaxResultsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidNextTokenException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.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.CloudTrail.Model.InvalidParameterCombinationException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.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.CloudTrail.Model.InvalidS3BucketNameException"> <summary> CloudTrail 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> CloudTrail 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> CloudTrail 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.InvalidTagParameterException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidTagParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidTagParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidTimeRangeException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidTimeRangeException.#ctor(System.String)"> <summary> Constructs a new InvalidTimeRangeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidTokenException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.InvalidTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.InvalidTrailNameException"> <summary> CloudTrail 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.KmsKeyDisabledException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.KmsKeyDisabledException.#ctor(System.String)"> <summary> Constructs a new KmsKeyDisabledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.KmsKeyNotFoundException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.KmsKeyNotFoundException.#ctor(System.String)"> <summary> Constructs a new KmsKeyNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.ListPublicKeysRequest"> <summary> Container for the parameters to the ListPublicKeys operation. Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> Reserved for future use. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.ListPublicKeysResponse"> <summary> Configuration for accessing Amazon ListPublicKeys service </summary> </member> <member name="T:Amazon.CloudTrail.Model.ListPublicKeysResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysResult.NextToken"> <summary> Gets and sets the property NextToken. <para> Reserved for future use. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysResult.PublicKeyList"> <summary> Gets and sets the property PublicKeyList. <para> Contains an array of PublicKey objects. </para> <note>The returned public keys may have validity time ranges that overlap.</note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListPublicKeysResponse.ListPublicKeysResult"> <summary> Gets and sets the ListPublicKeysResult property. Represents the output of a ListPublicKeys operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.ListTagsRequest"> <summary> Container for the parameters to the ListTags operation. Lists the tags for the specified trail or trails in the current region. <para> Lists the tags for the trail in the current region. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListTagsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> Reserved for future use. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListTagsRequest.ResourceIdList"> <summary> Gets and sets the property ResourceIdList. <para> Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.ListTagsResponse"> <summary> Configuration for accessing Amazon ListTags service </summary> </member> <member name="T:Amazon.CloudTrail.Model.ListTagsResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListTagsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> Reserved for future use. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListTagsResult.ResourceTagList"> <summary> Gets and sets the property ResourceTagList. </summary> </member> <member name="P:Amazon.CloudTrail.Model.ListTagsResponse.ListTagsResult"> <summary> Gets and sets the ListTagsResult property. Represents the output of a ListTags operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.LookupAttribute"> <summary> Specifies an attribute and value that filter the events returned. </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupAttribute.AttributeKey"> <summary> Gets and sets the property AttributeKey. <para> Specifies an attribute on which to filter the events returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupAttribute.AttributeValue"> <summary> Gets and sets the property AttributeValue. <para> Specifies a value for the specified AttributeKey. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.LookupEventsRequest"> <summary> Container for the parameters to the LookupEvents operation. Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports five different attributes: time range (defined by a start time and end time), user name, event name, resource type, and resource name. All attributes are optional. The maximum number of attributes that can be specified in any one lookup request are time range and one other attribute. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. <important>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs. </important> <important>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</important> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsRequest.LookupAttributes"> <summary> Gets and sets the property LookupAttributes. <para> Contains a list of lookup attributes. Currently the list can contain only one item. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The number of events to return. Possible values are 1 through 50. The default is 10. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.LookupEventsResponse"> <summary> Configuration for accessing Amazon LookupEvents service </summary> </member> <member name="T:Amazon.CloudTrail.Model.LookupEventsResult"> <summary> Contains a response to a LookupEvents action. </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsResult.Events"> <summary> Gets and sets the property Events. <para> A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.LookupEventsResponse.LookupEventsResult"> <summary> Gets and sets the LookupEventsResult property. Represents the output of a LookupEvents operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.MaximumNumberOfTrailsExceededException"> <summary> CloudTrail 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.OperationNotPermittedException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.OperationNotPermittedException.#ctor(System.String)"> <summary> Constructs a new OperationNotPermittedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.PublicKey"> <summary> Contains information about a returned public key. </summary> </member> <member name="P:Amazon.CloudTrail.Model.PublicKey.Fingerprint"> <summary> Gets and sets the property Fingerprint. <para> The fingerprint of the public key. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.PublicKey.ValidityEndTime"> <summary> Gets and sets the property ValidityEndTime. <para> The ending time of validity of the public key. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.PublicKey.ValidityStartTime"> <summary> Gets and sets the property ValidityStartTime. <para> The starting time of validity of the public key. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.PublicKey.Value"> <summary> Gets and sets the property Value. <para> The DER encoded public key value in PKCS#1 format. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.RemoveTagsRequest"> <summary> Container for the parameters to the RemoveTags operation. Removes the specified tags from a trail. </summary> </member> <member name="P:Amazon.CloudTrail.Model.RemoveTagsRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.RemoveTagsRequest.TagsList"> <summary> Gets and sets the property TagsList. <para> Specifies a list of tags to be removed. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.RemoveTagsResponse"> <summary> Configuration for accessing Amazon RemoveTags service </summary> </member> <member name="T:Amazon.CloudTrail.Model.RemoveTagsResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.RemoveTagsResponse.RemoveTagsResult"> <summary> Gets and sets the RemoveTagsResult property. Represents the output of a RemoveTags operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.Resource"> <summary> Specifies the type and name of a resource referenced by an event. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Resource.ResourceName"> <summary> Gets and sets the property ResourceName. <para> The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Resource.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2, <b>Trail</b> for CloudTrail, <b>DBInstance</b> for RDS, and <b>AccessKey</b> for IAM. For a list of resource types supported for event lookup, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/lookup_supported_resourcetypes.html">Resource Types Supported for Event Lookup</a>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.ResourceNotFoundException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.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.CloudTrail.Model.ResourceTag"> <summary> A resource tag. </summary> </member> <member name="P:Amazon.CloudTrail.Model.ResourceTag.ResourceId"> <summary> Gets and sets the property ResourceId. <para> Specifies the ARN of the resource. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.ResourceTag.TagsList"> <summary> Gets and sets the property TagsList. </summary> </member> <member name="T:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.ResourceTypeNotSupportedException.#ctor(System.String)"> <summary> Constructs a new ResourceTypeNotSupportedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.S3BucketDoesNotExistException"> <summary> CloudTrail 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. Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StartLoggingRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.StartLoggingResponse"> <summary> Configuration for accessing Amazon StartLogging service </summary> </member> <member name="T:Amazon.CloudTrail.Model.StartLoggingResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StartLoggingResponse.StartLoggingResult"> <summary> Gets and sets the StartLoggingResult property. Represents the output of a StartLogging operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingRequest"> <summary> Container for the parameters to the StopLogging operation. Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StopLoggingRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingResponse"> <summary> Configuration for accessing Amazon StopLogging service </summary> </member> <member name="T:Amazon.CloudTrail.Model.StopLoggingResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.StopLoggingResponse.StopLoggingResult"> <summary> Gets and sets the StopLoggingResult property. Represents the output of a StopLogging operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.Tag"> <summary> A custom key-value pair associated with a resource such as a CloudTrail trail. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.TagsLimitExceededException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.TagsLimitExceededException.#ctor(System.String)"> <summary> Constructs a new TagsLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudTrail.Model.Trail"> <summary> The settings for a trail. </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.CloudWatchLogsLogGroupArn"> <summary> Gets and sets the property CloudWatchLogsLogGroupArn. <para> Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.CloudWatchLogsRoleArn"> <summary> Gets and sets the property CloudWatchLogsRoleArn. <para> Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.HomeRegion"> <summary> Gets and sets the property HomeRegion. <para> The region in which the trail was created. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.IncludeGlobalServiceEvents"> <summary> Gets and sets the property IncludeGlobalServiceEvents. <para> Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.IsMultiRegionTrail"> <summary> Gets and sets the property IsMultiRegionTrail. <para> Specifies whether the trail belongs only to one region or exists in all regions. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: </para> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.LogFileValidationEnabled"> <summary> Gets and sets the property LogFileValidationEnabled. <para> Specifies whether log file validation is enabled. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.Name"> <summary> Gets and sets the property Name. <para> Name of the trail set by calling <a>CreateTrail</a>. The maximum length is 128 characters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>.The maximum length is 200 characters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.SnsTopicName"> <summary> Gets and sets the property SnsTopicName. <para> Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered. The maximum length is 256 characters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.Trail.TrailARN"> <summary> Gets and sets the property TrailARN. <para> The Amazon Resource Name of the trail. The <code>TrailARN</code> format is <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.TrailAlreadyExistsException"> <summary> CloudTrail 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> CloudTrail 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> CloudTrail 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.UnsupportedOperationException"> <summary> CloudTrail exception </summary> </member> <member name="M:Amazon.CloudTrail.Model.UnsupportedOperationException.#ctor(System.String)"> <summary> Constructs a new UnsupportedOperationException 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. Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.CloudWatchLogsLogGroupArn"> <summary> Gets and sets the property CloudWatchLogsLogGroupArn. <para> Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.CloudWatchLogsRoleArn"> <summary> Gets and sets the property CloudWatchLogsRoleArn. <para> Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.EnableLogFileValidation"> <summary> Gets and sets the property EnableLogFileValidation. <para> Specifies whether log file validation is enabled. The default is false. </para> <note>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</note> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.IncludeGlobalServiceEvents"> <summary> Gets and sets the property IncludeGlobalServiceEvents. <para> Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.IsMultiRegionTrail"> <summary> Gets and sets the property IsMultiRegionTrail. <para> Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. </para> <para> Examples: </para> <ul> <li>alias/MyAliasName</li> <li>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>12345678-1234-1234-1234-123456789012</li> </ul> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.Name"> <summary> Gets and sets the property Name. <para> Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the string must meet the following requirements: </para> <ul> <li>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</li> <li>Start with a letter or number, and end with a letter or number</li> <li>Be between 3 and 128 characters</li> <li>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</li> <li>Not be in IP address format (for example, 192.168.5.4)</li> </ul> <para> If <code>Name</code> is a trail ARN, it must be in the format <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailRequest.SnsTopicName"> <summary> Gets and sets the property SnsTopicName. <para> Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. </para> </summary> </member> <member name="T:Amazon.CloudTrail.Model.UpdateTrailResponse"> <summary> Configuration for accessing Amazon UpdateTrail service </summary> </member> <member name="T:Amazon.CloudTrail.Model.UpdateTrailResult"> <summary> Returns the objects or data listed below if successful. Otherwise, returns an error. </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.CloudWatchLogsLogGroupArn"> <summary> Gets and sets the property CloudWatchLogsLogGroupArn. <para> Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.CloudWatchLogsRoleArn"> <summary> Gets and sets the property CloudWatchLogsRoleArn. <para> Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.IncludeGlobalServiceEvents"> <summary> Gets and sets the property IncludeGlobalServiceEvents. <para> Specifies whether the trail is publishing events from global services such as IAM to the log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.IsMultiRegionTrail"> <summary> Gets and sets the property IsMultiRegionTrail. <para> Specifies whether the trail exists in one region or in all regions. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: </para> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.LogFileValidationEnabled"> <summary> Gets and sets the property LogFileValidationEnabled. <para> Specifies whether log file integrity validation is enabled. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.Name"> <summary> Gets and sets the property Name. <para> Specifies the name of the trail. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> Specifies the name of the Amazon S3 bucket designated for publishing log files. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.SnsTopicName"> <summary> Gets and sets the property SnsTopicName. <para> Specifies the name of the Amazon SNS topic defined for notification of log file delivery. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResult.TrailARN"> <summary> Gets and sets the property TrailARN. <para> Specifies the ARN of the trail that was updated. </para> </summary> </member> <member name="P:Amazon.CloudTrail.Model.UpdateTrailResponse.UpdateTrailResult"> <summary> Gets and sets the UpdateTrailResult property. Represents the output of a UpdateTrail operation. </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.AddTagsRequestMarshaller"> <summary> AddTags Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.AddTagsResponseUnmarshaller"> <summary> Response Unmarshaller for AddTags operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.CreateTrailRequestMarshaller"> <summary> CreateTrail 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.DeleteTrailRequestMarshaller"> <summary> DeleteTrail 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.DescribeTrailsRequestMarshaller"> <summary> DescribeTrails 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.EventUnmarshaller"> <summary> Response Unmarshaller for Event Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.GetTrailStatusRequestMarshaller"> <summary> GetTrailStatus 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.ListPublicKeysRequestMarshaller"> <summary> ListPublicKeys Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.ListPublicKeysResponseUnmarshaller"> <summary> Response Unmarshaller for ListPublicKeys operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.ListTagsRequestMarshaller"> <summary> ListTags Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.ListTagsResponseUnmarshaller"> <summary> Response Unmarshaller for ListTags operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.LookupAttributeMarshaller"> <summary> LookupAttribute Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.LookupEventsRequestMarshaller"> <summary> LookupEvents Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.LookupEventsResponseUnmarshaller"> <summary> Response Unmarshaller for LookupEvents operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.PublicKeyUnmarshaller"> <summary> Response Unmarshaller for PublicKey Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.RemoveTagsRequestMarshaller"> <summary> RemoveTags Request Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.RemoveTagsResponseUnmarshaller"> <summary> Response Unmarshaller for RemoveTags operation </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.ResourceTagUnmarshaller"> <summary> Response Unmarshaller for ResourceTag Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.ResourceUnmarshaller"> <summary> Response Unmarshaller for Resource Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.StartLoggingRequestMarshaller"> <summary> StartLogging 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.StopLoggingRequestMarshaller"> <summary> StopLogging 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.TagMarshaller"> <summary> Tag Marshaller </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.TrailUnmarshaller"> <summary> Response Unmarshaller for Trail Object </summary> </member> <member name="T:Amazon.CloudTrail.Model.Internal.MarshallTransformations.UpdateTrailRequestMarshaller"> <summary> UpdateTrail 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.ConfigService.AmazonConfigServiceClient"> <summary> Implementation for accessing ConfigService AWS Config <para> AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resources</a>. </para> <para> You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config </para> <para> This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. </para> <para> The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is AWS Config?</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.ConfigService.IAmazonConfigService"> <summary> Interface for accessing ConfigService AWS Config <para> AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resources</a>. </para> <para> You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config </para> <para> This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. </para> <para> The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <a href="http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 Signing Process</a>. </para> <para> For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is AWS Config?</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest)"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para> <para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule service method.</param> <returns>The response from the DeleteConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDeleteConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConfigRule.</param> <returns>Returns a DeleteConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteDeliveryChannel(System.String)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="deliveryChannelName">The name of the delivery channel to delete.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel service method.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeliveryChannel operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDeleteDeliveryChannel(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeliveryChannel.</param> <returns>Returns a DeleteDeliveryChannelResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeliverConfigSnapshot(System.String)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="deliveryChannelName">The name of the delivery channel through which the snapshot is delivered.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot service method.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeliverConfigSnapshot operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDeliverConfigSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeliverConfigSnapshot.</param> <returns>Returns a DeliverConfigSnapshotResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest)"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule service method.</param> <returns>The response from the DescribeComplianceByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeComplianceByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeComplianceByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeComplianceByConfigRule.</param> <returns>Returns a DescribeComplianceByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest)"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para> <para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource service method.</param> <returns>The response from the DescribeComplianceByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeComplianceByResource operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeComplianceByResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeComplianceByResource.</param> <returns>Returns a DescribeComplianceByResourceResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest)"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus service method.</param> <returns>The response from the DescribeConfigRuleEvaluationStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigRuleEvaluationStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeConfigRuleEvaluationStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigRuleEvaluationStatus.</param> <returns>Returns a DescribeConfigRuleEvaluationStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest)"> <summary> Returns details about your AWS Config rules. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules service method.</param> <returns>The response from the DescribeConfigRules service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigRules operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeConfigRules(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigRules.</param> <returns>Returns a DescribeConfigRulesResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorders"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest)"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders service method.</param> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationRecorders operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeConfigurationRecorders(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationRecorders.</param> <returns>Returns a DescribeConfigurationRecordersResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorderStatus"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest)"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method.</param> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationRecorderStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeConfigurationRecorderStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationRecorderStatus.</param> <returns>Returns a DescribeConfigurationRecorderStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannels"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest)"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels service method.</param> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDeliveryChannels operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeDeliveryChannels(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDeliveryChannels.</param> <returns>Returns a DescribeDeliveryChannelsResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelStatus"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.DescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest)"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method.</param> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginDescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDeliveryChannelStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndDescribeDeliveryChannelStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDeliveryChannelStatus.</param> <returns>Returns a DescribeDeliveryChannelStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest)"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule service method.</param> <returns>The response from the GetComplianceDetailsByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginGetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceDetailsByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndGetComplianceDetailsByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceDetailsByConfigRule.</param> <returns>Returns a GetComplianceDetailsByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest)"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource service method.</param> <returns>The response from the GetComplianceDetailsByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginGetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceDetailsByResource operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndGetComplianceDetailsByResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceDetailsByResource.</param> <returns>Returns a GetComplianceDetailsByResourceResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest)"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule service method.</param> <returns>The response from the GetComplianceSummaryByConfigRule service method, as returned by ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginGetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceSummaryByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndGetComplianceSummaryByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceSummaryByConfigRule.</param> <returns>Returns a GetComplianceSummaryByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest)"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType service method.</param> <returns>The response from the GetComplianceSummaryByResourceType service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginGetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceSummaryByResourceType operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndGetComplianceSummaryByResourceType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceSummaryByResourceType.</param> <returns>Returns a GetComplianceSummaryByResourceTypeResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.GetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest)"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> <note> <para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory service method.</param> <returns>The response from the GetResourceConfigHistory service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidTimeRangeException"> The specified time range is not valid. The earlier time is not chronologically before the later time. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceNotDiscoveredException"> You have specified a resource that is either unknown or has not been discovered. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginGetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetResourceConfigHistory operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndGetResourceConfigHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetResourceConfigHistory.</param> <returns>Returns a GetResourceConfigHistoryResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.ListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest)"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note> <para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources service method.</param> <returns>The response from the ListDiscoveredResources service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDiscoveredResources operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndListDiscoveredResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDiscoveredResources.</param> <returns>Returns a ListDiscoveredResourcesResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest)"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para> <para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para> <para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para> <para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para> <para> The maximum number of rules that AWS Config supports is 25. </para> <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule service method.</param> <returns>The response from the PutConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientPermissionsException"> Indicates one of the following errors: <ul> <li>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</li> <li>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</li> </ul> </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException"> Failed to add the AWS Config rule because the account already contains the maximum number of 25 rules. Consider deleting any deactivated rules before adding new rules. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginPutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndPutConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutConfigRule.</param> <returns>Returns a PutConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest)"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para> <note> <para> Currently, you can specify only one configuration recorder per account. </para> <para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder service method.</param> <returns>The response from the PutConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException"> You have provided a configuration recorder name that is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRecordingGroupException"> AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRoleException"> You have provided a null or empty role ARN. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException"> You have reached the limit on the number of recorders you can create. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginPutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndPutConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutConfigurationRecorder.</param> <returns>Returns a PutConfigurationRecorderResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest)"> <summary> Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para> <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel service method.</param> <returns>The response from the PutDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException"> Your Amazon S3 bucket policy does not permit AWS Config to write to it. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException"> The specified delivery channel name is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidS3KeyPrefixException"> The specified Amazon S3 key prefix is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidSNSTopicARNException"> The specified Amazon SNS topic does not exist. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException"> You have reached the limit on the number of delivery channels you can create. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchBucketException"> The specified Amazon S3 bucket does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginPutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDeliveryChannel operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndPutDeliveryChannel(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDeliveryChannel.</param> <returns>Returns a PutDeliveryChannelResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.PutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest)"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations service method.</param> <returns>The response from the PutEvaluations service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidResultTokenException"> The result token is invalid. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginPutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutEvaluations operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndPutEvaluations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutEvaluations operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutEvaluations.</param> <returns>Returns a PutEvaluationsResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StartConfigurationRecorder(System.String)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder service method.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginStartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndStartConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartConfigurationRecorder.</param> <returns>Returns a StartConfigurationRecorderResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StopConfigurationRecorder(System.String)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.StopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder service method.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.BeginStopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.IAmazonConfigService.EndStopConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopConfigurationRecorder.</param> <returns>Returns a StopConfigurationRecorderResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Credentials and an AmazonConfigServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonConfigServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.#ctor(System.String,System.String,System.String,Amazon.ConfigService.AmazonConfigServiceConfig)"> <summary> Constructs AmazonConfigServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonConfigServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonConfigServiceClient Configuration Object</param> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest)"> <summary> Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para> <para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule service method.</param> <returns>The response from the DeleteConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDeleteConfigRule(Amazon.ConfigService.Model.DeleteConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDeleteConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConfigRule.</param> <returns>Returns a DeleteConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteDeliveryChannel(System.String)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="deliveryChannelName">The name of the delivery channel to delete.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest)"> <summary> Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel service method.</param> <returns>The response from the DeleteDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> You cannot delete the delivery channel you specified because the configuration recorder is running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDeleteDeliveryChannel(Amazon.ConfigService.Model.DeleteDeliveryChannelRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDeliveryChannel operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDeliveryChannel operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDeleteDeliveryChannel(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDeliveryChannel operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDeliveryChannel.</param> <returns>Returns a DeleteDeliveryChannelResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeliverConfigSnapshot(System.String)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="deliveryChannelName">The name of the delivery channel through which the snapshot is delivered.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest)"> <summary> Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot service method.</param> <returns>The response from the DeliverConfigSnapshot service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> There is no configuration recorder running. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDeliverConfigSnapshot(Amazon.ConfigService.Model.DeliverConfigSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeliverConfigSnapshot operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeliverConfigSnapshot operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDeliverConfigSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeliverConfigSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeliverConfigSnapshot.</param> <returns>Returns a DeliverConfigSnapshotResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest)"> <summary> Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule service method.</param> <returns>The response from the DescribeComplianceByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeComplianceByConfigRule(Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeComplianceByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeComplianceByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeComplianceByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeComplianceByConfigRule.</param> <returns>Returns a DescribeComplianceByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest)"> <summary> Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para> <para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource service method.</param> <returns>The response from the DescribeComplianceByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeComplianceByResource(Amazon.ConfigService.Model.DescribeComplianceByResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeComplianceByResource operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeComplianceByResource operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeComplianceByResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeComplianceByResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeComplianceByResource.</param> <returns>Returns a DescribeComplianceByResourceResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest)"> <summary> Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus service method.</param> <returns>The response from the DescribeConfigRuleEvaluationStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeConfigRuleEvaluationStatus(Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRuleEvaluationStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigRuleEvaluationStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeConfigRuleEvaluationStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigRuleEvaluationStatus.</param> <returns>Returns a DescribeConfigRuleEvaluationStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest)"> <summary> Returns details about your AWS Config rules. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules service method.</param> <returns>The response from the DescribeConfigRules service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeConfigRules(Amazon.ConfigService.Model.DescribeConfigRulesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigRules operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigRules operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeConfigRules(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigRules operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigRules.</param> <returns>Returns a DescribeConfigRulesResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorders"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest)"> <summary> Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders service method.</param> <returns>The response from the DescribeConfigurationRecorders service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeConfigurationRecorders(Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorders operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationRecorders operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeConfigurationRecorders(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationRecorders operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationRecorders.</param> <returns>Returns a DescribeConfigurationRecordersResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorderStatus"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest)"> <summary> Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method.</param> <returns>The response from the DescribeConfigurationRecorderStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeConfigurationRecorderStatus(Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConfigurationRecorderStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeConfigurationRecorderStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConfigurationRecorderStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConfigurationRecorderStatus.</param> <returns>Returns a DescribeConfigurationRecorderStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannels"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest)"> <summary> Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels service method.</param> <returns>The response from the DescribeDeliveryChannels service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeDeliveryChannels(Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannels operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDeliveryChannels operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeDeliveryChannels(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDeliveryChannels operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDeliveryChannels.</param> <returns>Returns a DescribeDeliveryChannelsResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelStatus"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.DescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest)"> <summary> Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method.</param> <returns>The response from the DescribeDeliveryChannelStatus service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> You have specified a delivery channel that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginDescribeDeliveryChannelStatus(Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDeliveryChannelStatus operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDeliveryChannelStatus operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndDescribeDeliveryChannelStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDeliveryChannelStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDeliveryChannelStatus.</param> <returns>Returns a DescribeDeliveryChannelStatusResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest)"> <summary> Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule service method.</param> <returns>The response from the GetComplianceDetailsByConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginGetComplianceDetailsByConfigRule(Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceDetailsByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndGetComplianceDetailsByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceDetailsByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceDetailsByConfigRule.</param> <returns>Returns a GetComplianceDetailsByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest)"> <summary> Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource service method.</param> <returns>The response from the GetComplianceDetailsByResource service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginGetComplianceDetailsByResource(Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceDetailsByResource operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceDetailsByResource operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndGetComplianceDetailsByResource(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceDetailsByResource operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceDetailsByResource.</param> <returns>Returns a GetComplianceDetailsByResourceResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest)"> <summary> Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule service method.</param> <returns>The response from the GetComplianceSummaryByConfigRule service method, as returned by ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginGetComplianceSummaryByConfigRule(Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceSummaryByConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndGetComplianceSummaryByConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceSummaryByConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceSummaryByConfigRule.</param> <returns>Returns a GetComplianceSummaryByConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest)"> <summary> Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType service method.</param> <returns>The response from the GetComplianceSummaryByResourceType service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginGetComplianceSummaryByResourceType(Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="request">Container for the necessary parameters to execute the GetComplianceSummaryByResourceType operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetComplianceSummaryByResourceType operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndGetComplianceSummaryByResourceType(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetComplianceSummaryByResourceType operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetComplianceSummaryByResourceType.</param> <returns>Returns a GetComplianceSummaryByResourceTypeResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.GetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest)"> <summary> Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> <note> <para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory service method.</param> <returns>The response from the GetResourceConfigHistory service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidTimeRangeException"> The specified time range is not valid. The earlier time is not chronologically before the later time. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceNotDiscoveredException"> You have specified a resource that is either unknown or has not been discovered. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginGetResourceConfigHistory(Amazon.ConfigService.Model.GetResourceConfigHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the GetResourceConfigHistory operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetResourceConfigHistory operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndGetResourceConfigHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetResourceConfigHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetResourceConfigHistory.</param> <returns>Returns a GetResourceConfigHistoryResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.ListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest)"> <summary> Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note> <para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources service method.</param> <returns>The response from the ListDiscoveredResources service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidLimitException"> The specified limit is outside the allowable range. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidNextTokenException"> The specified next token is invalid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.ValidationException"> The requested action is not valid. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginListDiscoveredResources(Amazon.ConfigService.Model.ListDiscoveredResourcesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDiscoveredResources operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDiscoveredResources operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndListDiscoveredResources(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDiscoveredResources operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDiscoveredResources.</param> <returns>Returns a ListDiscoveredResourcesResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest)"> <summary> Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para> <para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para> <para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para> <para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para> <para> The maximum number of rules that AWS Config supports is 25. </para> <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule service method.</param> <returns>The response from the PutConfigRule service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientPermissionsException"> Indicates one of the following errors: <ul> <li>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</li> <li>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</li> </ul> </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException"> Failed to add the AWS Config rule because the account already contains the maximum number of 25 rules. Consider deleting any deactivated rules before adding new rules. </exception> <exception cref="T:Amazon.ConfigService.Model.ResourceInUseException"> The rule is currently being deleted. Wait for a while and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginPutConfigRule(Amazon.ConfigService.Model.PutConfigRuleRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutConfigRule operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigRule operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutConfigRule operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndPutConfigRule(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutConfigRule operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutConfigRule.</param> <returns>Returns a PutConfigRuleResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest)"> <summary> Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para> <note> <para> Currently, you can specify only one configuration recorder per account. </para> <para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder service method.</param> <returns>The response from the PutConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException"> You have provided a configuration recorder name that is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRecordingGroupException"> AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidRoleException"> You have provided a null or empty role ARN. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException"> You have reached the limit on the number of recorders you can create. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginPutConfigurationRecorder(Amazon.ConfigService.Model.PutConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the PutConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndPutConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutConfigurationRecorder.</param> <returns>Returns a PutConfigurationRecorderResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest)"> <summary> Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para> <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel service method.</param> <returns>The response from the PutDeliveryChannel service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException"> Your Amazon S3 bucket policy does not permit AWS Config to write to it. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException"> The specified delivery channel name is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidS3KeyPrefixException"> The specified Amazon S3 key prefix is not valid. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidSNSTopicARNException"> The specified Amazon SNS topic does not exist. </exception> <exception cref="T:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException"> You have reached the limit on the number of delivery channels you can create. </exception> <exception cref="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchBucketException"> The specified Amazon S3 bucket does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginPutDeliveryChannel(Amazon.ConfigService.Model.PutDeliveryChannelRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDeliveryChannel operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDeliveryChannel operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndPutDeliveryChannel(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDeliveryChannel operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDeliveryChannel.</param> <returns>Returns a PutDeliveryChannelResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.PutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest)"> <summary> Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations service method.</param> <returns>The response from the PutEvaluations service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.InvalidParameterValueException"> One or more of the specified parameters are invalid. Verify that your parameters are valid and try again. </exception> <exception cref="T:Amazon.ConfigService.Model.InvalidResultTokenException"> The result token is invalid. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginPutEvaluations(Amazon.ConfigService.Model.PutEvaluationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutEvaluations operation. </summary> <param name="request">Container for the necessary parameters to execute the PutEvaluations operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutEvaluations operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndPutEvaluations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutEvaluations operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutEvaluations.</param> <returns>Returns a PutEvaluationsResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StartConfigurationRecorder(System.String)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest)"> <summary> Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder service method.</param> <returns>The response from the StartConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> There is no delivery channel available to record configurations. </exception> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginStartConfigurationRecorder(Amazon.ConfigService.Model.StartConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StartConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndStartConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartConfigurationRecorder.</param> <returns>Returns a StartConfigurationRecorderResult from ConfigService.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StopConfigurationRecorder(System.String)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="configurationRecorderName">The name of the recorder object that records each configuration change made to the resources.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.StopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest)"> <summary> Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder service method.</param> <returns>The response from the StopConfigurationRecorder service method, as returned by ConfigService.</returns> <exception cref="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> You have specified a configuration recorder that does not exist. </exception> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.BeginStopConfigurationRecorder(Amazon.ConfigService.Model.StopConfigurationRecorderRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="request">Container for the necessary parameters to execute the StopConfigurationRecorder operation on AmazonConfigServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopConfigurationRecorder operation.</returns> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceClient.EndStopConfigurationRecorder(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopConfigurationRecorder operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopConfigurationRecorder.</param> <returns>Returns a StopConfigurationRecorderResult from ConfigService.</returns> </member> <member name="T:Amazon.ConfigService.AmazonConfigServiceConfig"> <summary> Configuration for accessing Amazon ConfigService service </summary> </member> <member name="M:Amazon.ConfigService.AmazonConfigServiceConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ConfigService.AmazonConfigServiceConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ConfigService.AmazonConfigServiceConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ConfigService.ChronologicalOrder"> <summary> Constants used for properties of type ChronologicalOrder. </summary> </member> <member name="F:Amazon.ConfigService.ChronologicalOrder.Forward"> <summary> Constant Forward for ChronologicalOrder </summary> </member> <member name="F:Amazon.ConfigService.ChronologicalOrder.Reverse"> <summary> Constant Reverse for ChronologicalOrder </summary> </member> <member name="M:Amazon.ConfigService.ChronologicalOrder.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.ChronologicalOrder.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.ComplianceType"> <summary> Constants used for properties of type ComplianceType. </summary> </member> <member name="F:Amazon.ConfigService.ComplianceType.COMPLIANT"> <summary> Constant COMPLIANT for ComplianceType </summary> </member> <member name="F:Amazon.ConfigService.ComplianceType.INSUFFICIENT_DATA"> <summary> Constant INSUFFICIENT_DATA for ComplianceType </summary> </member> <member name="F:Amazon.ConfigService.ComplianceType.NON_COMPLIANT"> <summary> Constant NON_COMPLIANT for ComplianceType </summary> </member> <member name="F:Amazon.ConfigService.ComplianceType.NOT_APPLICABLE"> <summary> Constant NOT_APPLICABLE for ComplianceType </summary> </member> <member name="M:Amazon.ConfigService.ComplianceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.ComplianceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.ConfigRuleState"> <summary> Constants used for properties of type ConfigRuleState. </summary> </member> <member name="F:Amazon.ConfigService.ConfigRuleState.ACTIVE"> <summary> Constant ACTIVE for ConfigRuleState </summary> </member> <member name="F:Amazon.ConfigService.ConfigRuleState.DELETING"> <summary> Constant DELETING for ConfigRuleState </summary> </member> <member name="M:Amazon.ConfigService.ConfigRuleState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.ConfigRuleState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.ConfigurationItemStatus"> <summary> Constants used for properties of type ConfigurationItemStatus. </summary> </member> <member name="F:Amazon.ConfigService.ConfigurationItemStatus.Deleted"> <summary> Constant Deleted for ConfigurationItemStatus </summary> </member> <member name="F:Amazon.ConfigService.ConfigurationItemStatus.Discovered"> <summary> Constant Discovered for ConfigurationItemStatus </summary> </member> <member name="F:Amazon.ConfigService.ConfigurationItemStatus.Failed"> <summary> Constant Failed for ConfigurationItemStatus </summary> </member> <member name="F:Amazon.ConfigService.ConfigurationItemStatus.Ok"> <summary> Constant Ok for ConfigurationItemStatus </summary> </member> <member name="M:Amazon.ConfigService.ConfigurationItemStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.ConfigurationItemStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.DeliveryStatus"> <summary> Constants used for properties of type DeliveryStatus. </summary> </member> <member name="F:Amazon.ConfigService.DeliveryStatus.Failure"> <summary> Constant Failure for DeliveryStatus </summary> </member> <member name="F:Amazon.ConfigService.DeliveryStatus.Not_Applicable"> <summary> Constant Not_Applicable for DeliveryStatus </summary> </member> <member name="F:Amazon.ConfigService.DeliveryStatus.Success"> <summary> Constant Success for DeliveryStatus </summary> </member> <member name="M:Amazon.ConfigService.DeliveryStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.DeliveryStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.EventSource"> <summary> Constants used for properties of type EventSource. </summary> </member> <member name="F:Amazon.ConfigService.EventSource.AwsConfig"> <summary> Constant AwsConfig for EventSource </summary> </member> <member name="M:Amazon.ConfigService.EventSource.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.EventSource.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.MaximumExecutionFrequency"> <summary> Constants used for properties of type MaximumExecutionFrequency. </summary> </member> <member name="F:Amazon.ConfigService.MaximumExecutionFrequency.One_Hour"> <summary> Constant One_Hour for MaximumExecutionFrequency </summary> </member> <member name="F:Amazon.ConfigService.MaximumExecutionFrequency.Six_Hours"> <summary> Constant Six_Hours for MaximumExecutionFrequency </summary> </member> <member name="F:Amazon.ConfigService.MaximumExecutionFrequency.Three_Hours"> <summary> Constant Three_Hours for MaximumExecutionFrequency </summary> </member> <member name="F:Amazon.ConfigService.MaximumExecutionFrequency.Twelve_Hours"> <summary> Constant Twelve_Hours for MaximumExecutionFrequency </summary> </member> <member name="F:Amazon.ConfigService.MaximumExecutionFrequency.TwentyFour_Hours"> <summary> Constant TwentyFour_Hours for MaximumExecutionFrequency </summary> </member> <member name="M:Amazon.ConfigService.MaximumExecutionFrequency.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.MaximumExecutionFrequency.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.MessageType"> <summary> Constants used for properties of type MessageType. </summary> </member> <member name="F:Amazon.ConfigService.MessageType.ConfigurationItemChangeNotification"> <summary> Constant ConfigurationItemChangeNotification for MessageType </summary> </member> <member name="F:Amazon.ConfigService.MessageType.ConfigurationSnapshotDeliveryCompleted"> <summary> Constant ConfigurationSnapshotDeliveryCompleted for MessageType </summary> </member> <member name="M:Amazon.ConfigService.MessageType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.MessageType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.Owner"> <summary> Constants used for properties of type Owner. </summary> </member> <member name="F:Amazon.ConfigService.Owner.AWS"> <summary> Constant AWS for Owner </summary> </member> <member name="F:Amazon.ConfigService.Owner.CUSTOM_LAMBDA"> <summary> Constant CUSTOM_LAMBDA for Owner </summary> </member> <member name="M:Amazon.ConfigService.Owner.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.Owner.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.RecorderStatus"> <summary> Constants used for properties of type RecorderStatus. </summary> </member> <member name="F:Amazon.ConfigService.RecorderStatus.Failure"> <summary> Constant Failure for RecorderStatus </summary> </member> <member name="F:Amazon.ConfigService.RecorderStatus.Pending"> <summary> Constant Pending for RecorderStatus </summary> </member> <member name="F:Amazon.ConfigService.RecorderStatus.Success"> <summary> Constant Success for RecorderStatus </summary> </member> <member name="M:Amazon.ConfigService.RecorderStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.RecorderStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.ResourceType"> <summary> Constants used for properties of type ResourceType. </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSCloudTrailTrail"> <summary> Constant AWSCloudTrailTrail for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2CustomerGateway"> <summary> Constant AWSEC2CustomerGateway for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2EIP"> <summary> Constant AWSEC2EIP for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2Host"> <summary> Constant AWSEC2Host for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2Instance"> <summary> Constant AWSEC2Instance for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2InternetGateway"> <summary> Constant AWSEC2InternetGateway for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2NetworkAcl"> <summary> Constant AWSEC2NetworkAcl for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2NetworkInterface"> <summary> Constant AWSEC2NetworkInterface for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2RouteTable"> <summary> Constant AWSEC2RouteTable for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2SecurityGroup"> <summary> Constant AWSEC2SecurityGroup for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2Subnet"> <summary> Constant AWSEC2Subnet for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2Volume"> <summary> Constant AWSEC2Volume for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2VPC"> <summary> Constant AWSEC2VPC for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2VPNConnection"> <summary> Constant AWSEC2VPNConnection for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSEC2VPNGateway"> <summary> Constant AWSEC2VPNGateway for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSIAMGroup"> <summary> Constant AWSIAMGroup for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSIAMPolicy"> <summary> Constant AWSIAMPolicy for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSIAMRole"> <summary> Constant AWSIAMRole for ResourceType </summary> </member> <member name="F:Amazon.ConfigService.ResourceType.AWSIAMUser"> <summary> Constant AWSIAMUser for ResourceType </summary> </member> <member name="M:Amazon.ConfigService.ResourceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ConfigService.ResourceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ConfigService.AmazonConfigServiceRequest"> <summary> Base class for ConfigService operation requests. </summary> </member> <member name="T:Amazon.ConfigService.Model.Compliance"> <summary> Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance. </summary> </member> <member name="P:Amazon.ConfigService.Model.Compliance.ComplianceContributorCount"> <summary> Gets and sets the property ComplianceContributorCount. <para> The number of AWS resources or AWS Config rules that cause a result of <code>NON_COMPLIANT</code>, up to a maximum of 25. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Compliance.ComplianceType"> <summary> Gets and sets the property ComplianceType. <para> Indicates whether an AWS resource or AWS Config rule is compliant. </para> <para> A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules. </para> <para> A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> AWS Config returns the <code>INSUFFICIENT_DATA</code> value when no evaluation results are available for the AWS resource or Config rule. </para> <para> For the <code>Compliance</code> data type, AWS Config supports only <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>INSUFFICIENT_DATA</code> values. AWS Config does not support the <code>NOT_APPLICABLE</code> value for the <code>Compliance</code> data type. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ComplianceByConfigRule"> <summary> Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it, and it is noncompliant if any of these resources do not comply. </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceByConfigRule.Compliance"> <summary> Gets and sets the property Compliance. <para> Indicates whether the AWS Config rule is compliant. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceByConfigRule.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name of the AWS Config rule. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ComplianceByResource"> <summary> Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules. </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceByResource.Compliance"> <summary> Gets and sets the property Compliance. <para> Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceByResource.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the AWS resource that was evaluated. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceByResource.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of the AWS resource that was evaluated. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ComplianceContributorCount"> <summary> The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number. </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceContributorCount.CapExceeded"> <summary> Gets and sets the property CapExceeded. <para> Indicates whether the maximum count is reached. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceContributorCount.CappedCount"> <summary> Gets and sets the property CappedCount. <para> The number of AWS resources or AWS Config rules responsible for the current compliance of the item. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ComplianceSummary"> <summary> The number of AWS Config rules or AWS resources that are compliant and noncompliant, up to a maximum. </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceSummary.ComplianceSummaryTimestamp"> <summary> Gets and sets the property ComplianceSummaryTimestamp. <para> The time that AWS Config created the compliance summary. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceSummary.CompliantResourceCount"> <summary> Gets and sets the property CompliantResourceCount. <para> The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceSummary.NonCompliantResourceCount"> <summary> Gets and sets the property NonCompliantResourceCount. <para> The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ComplianceSummaryByResourceType"> <summary> The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each compliance. </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceSummaryByResourceType.ComplianceSummary"> <summary> Gets and sets the property ComplianceSummary. <para> The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ComplianceSummaryByResourceType.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of AWS resource. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigExportDeliveryInfo"> <summary> A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket. </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.LastAttemptTime"> <summary> Gets and sets the property LastAttemptTime. <para> The time of the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.LastErrorCode"> <summary> Gets and sets the property LastErrorCode. <para> The error code from the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.LastErrorMessage"> <summary> Gets and sets the property LastErrorMessage. <para> The error message from the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.LastStatus"> <summary> Gets and sets the property LastStatus. <para> Status of the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.LastSuccessfulTime"> <summary> Gets and sets the property LastSuccessfulTime. <para> The time of the last successful delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigExportDeliveryInfo.NextDeliveryTime"> <summary> Gets and sets the property NextDeliveryTime. <para> The time that the next delivery occurs. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigRule"> <summary> An AWS Lambda function that evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change or delivers a configuration snapshot. <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.ConfigRuleArn"> <summary> Gets and sets the property ConfigRuleArn. <para> The Amazon Resource Name (ARN) of the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.ConfigRuleId"> <summary> Gets and sets the property ConfigRuleId. <para> The ID of the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name that you assign to the AWS Config rule. The name is required if you are adding a new rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.ConfigRuleState"> <summary> Gets and sets the property ConfigRuleState. <para> Indicates whether the AWS Config rule is active or currently being deleted by AWS Config. </para> <para> AWS Config sets the state of a rule to <code>DELETING</code> temporarily after you use the <code>DeleteConfigRule</code> request to delete the rule. After AWS Config finishes deleting a rule, the rule and all of its evaluations are erased and no longer available. </para> <para> You cannot add a rule to AWS Config that has the state set to <code>DELETING</code>. If you want to delete a rule, you must use the <code>DeleteConfigRule</code> request. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.Description"> <summary> Gets and sets the property Description. <para> The description that you provide for the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.InputParameters"> <summary> Gets and sets the property InputParameters. <para> A string in JSON format that is passed to the AWS Config rule Lambda function. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.MaximumExecutionFrequency"> <summary> Gets and sets the property MaximumExecutionFrequency. <para> The maximum frequency at which the AWS Config rule runs evaluations. </para> <para> If your rule is periodic, meaning it runs an evaluation when AWS Config delivers a configuration snapshot, then it cannot run evaluations more frequently than AWS Config delivers the snapshots. For periodic rules, set the value of the <code>MaximumExecutionFrequency</code> key to be equal to or greater than the value of the <code>deliveryFrequency</code> key, which is part of <code>ConfigSnapshotDeliveryProperties</code>. To update the frequency with which AWS Config delivers your snapshots, use the <code>PutDeliveryChannel</code> action. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.Scope"> <summary> Gets and sets the property Scope. <para> Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRule.Source"> <summary> Gets and sets the property Source. <para> Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus"> <summary> Status information for your AWS managed Config rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure. <para> This action does not return status information about customer managed Config rules. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.ConfigRuleArn"> <summary> Gets and sets the property ConfigRuleArn. <para> The Amazon Resource Name (ARN) of the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.ConfigRuleId"> <summary> Gets and sets the property ConfigRuleId. <para> The ID of the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name of the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.FirstActivatedTime"> <summary> Gets and sets the property FirstActivatedTime. <para> The time that you first activated the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.FirstEvaluationStarted"> <summary> Gets and sets the property FirstEvaluationStarted. <para> Indicates whether AWS Config has evaluated your resources against the rule at least once. </para> <ul> <li><code>true</code> - AWS Config has evaluated your AWS resources against the rule at least once.</li> <li><code>false</code> - AWS Config has not once finished evaluating your AWS resources against the rule.</li> </ul> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastErrorCode"> <summary> Gets and sets the property LastErrorCode. <para> The error code that AWS Config returned when the rule last failed. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastErrorMessage"> <summary> Gets and sets the property LastErrorMessage. <para> The error message that AWS Config returned when the rule last failed. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastFailedEvaluationTime"> <summary> Gets and sets the property LastFailedEvaluationTime. <para> The time that AWS Config last failed to evaluate your AWS resources against the rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastFailedInvocationTime"> <summary> Gets and sets the property LastFailedInvocationTime. <para> The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastSuccessfulEvaluationTime"> <summary> Gets and sets the property LastSuccessfulEvaluationTime. <para> The time that AWS Config last successfully evaluated your AWS resources against the rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigRuleEvaluationStatus.LastSuccessfulInvocationTime"> <summary> Gets and sets the property LastSuccessfulInvocationTime. <para> The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigSnapshotDeliveryProperties"> <summary> Options for how AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel. </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigSnapshotDeliveryProperties.DeliveryFrequency"> <summary> Gets and sets the property DeliveryFrequency. <para> The frequency with which a AWS Config recurringly delivers configuration snapshots. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigStreamDeliveryInfo"> <summary> A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic. </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigStreamDeliveryInfo.LastErrorCode"> <summary> Gets and sets the property LastErrorCode. <para> The error code from the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigStreamDeliveryInfo.LastErrorMessage"> <summary> Gets and sets the property LastErrorMessage. <para> The error message from the last attempted delivery. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigStreamDeliveryInfo.LastStatus"> <summary> Gets and sets the property LastStatus. <para> Status of the last attempted delivery. </para> <para> <b>Note</b> Providing an SNS topic on a <a href="http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html">DeliveryChannel</a> for AWS Config is optional. If the SNS delivery is turned off, the last status will be <b>Not_Applicable</b>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigStreamDeliveryInfo.LastStatusChangeTime"> <summary> Gets and sets the property LastStatusChangeTime. <para> The time from the last status change. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigurationItem"> <summary> A list that contains detailed configurations of a specified resource. <note> <para> Currently, the list does not contain information about non-AWS components (for example, applications on your Amazon EC2 instances). </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.AccountId"> <summary> Gets and sets the property AccountId. <para> The 12 digit AWS account ID associated with the resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone associated with the resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.AwsRegion"> <summary> Gets and sets the property AwsRegion. <para> The region where the resource resides. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.Configuration"> <summary> Gets and sets the property Configuration. <para> The description of the resource configuration. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ConfigurationItemCaptureTime"> <summary> Gets and sets the property ConfigurationItemCaptureTime. <para> The time when the configuration recording was initiated. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ConfigurationItemMD5Hash"> <summary> Gets and sets the property ConfigurationItemMD5Hash. <para> Unique MD5 hash that represents the configuration item's state. </para> <para> You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ConfigurationItemStatus"> <summary> Gets and sets the property ConfigurationItemStatus. <para> The configuration item status. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ConfigurationStateId"> <summary> Gets and sets the property ConfigurationStateId. <para> An identifier that indicates the ordering of the configuration items of a resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.RelatedEvents"> <summary> Gets and sets the property RelatedEvents. <para> A list of CloudTrail event IDs. </para> <para> A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">What is AWS CloudTrail?</a>. </para> <para> An empty field indicates that the current configuration was not initiated by any event. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.Relationships"> <summary> Gets and sets the property Relationships. <para> A list of related AWS resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ResourceCreationTime"> <summary> Gets and sets the property ResourceCreationTime. <para> The time stamp when the resource was created. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource (for example., <code>sg-xxxxxx</code>). </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ResourceName"> <summary> Gets and sets the property ResourceName. <para> The custom name of the resource, if available. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of AWS resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.Tags"> <summary> Gets and sets the property Tags. <para> A mapping of key value tags associated with the resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationItem.Version"> <summary> Gets and sets the property Version. <para> The version number of the resource configuration. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigurationRecorder"> <summary> An object that represents the recording of configuration changes of an AWS resource. </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorder.Name"> <summary> Gets and sets the property Name. <para> The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorder.RecordingGroup"> <summary> Gets and sets the property RecordingGroup. <para> Specifies the types of AWS resource for which AWS Config records configuration changes. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorder.RoleARN"> <summary> Gets and sets the property RoleARN. <para> Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ConfigurationRecorderStatus"> <summary> The current status of the configuration recorder. </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastErrorCode"> <summary> Gets and sets the property LastErrorCode. <para> The error code indicating that the recording failed. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastErrorMessage"> <summary> Gets and sets the property LastErrorMessage. <para> The message indicating that the recording failed due to an error. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastStartTime"> <summary> Gets and sets the property LastStartTime. <para> The time the recorder was last started. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastStatus"> <summary> Gets and sets the property LastStatus. <para> The last (previous) status of the recorder. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastStatusChangeTime"> <summary> Gets and sets the property LastStatusChangeTime. <para> The time when the status was last changed. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.LastStopTime"> <summary> Gets and sets the property LastStopTime. <para> The time the recorder was last stopped. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.Name"> <summary> Gets and sets the property Name. <para> The name of the configuration recorder. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ConfigurationRecorderStatus.Recording"> <summary> Gets and sets the property Recording. <para> Specifies whether the recorder is currently recording or not. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DeleteConfigRuleRequest"> <summary> Container for the parameters to the DeleteConfigRule operation. Deletes the specified AWS Config rule and all of its evaluation results. <para> AWS Config sets the state of a rule to <code>DELETING</code> until the deletion is complete. You cannot update a rule while it is in this state. If you make a <code>PutConfigRule</code> request for the rule, you will receive a <code>ResourceInUseException</code>. </para> <para> You can check the state of a rule by using the <code>DescribeConfigRules</code> request. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeleteConfigRuleRequest.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name of the AWS Config rule that you want to delete. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DeleteDeliveryChannelRequest"> <summary> Container for the parameters to the DeleteDeliveryChannel operation. Deletes the specified delivery channel. <para> The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the <a>StopConfigurationRecorder</a> action. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeleteDeliveryChannelRequest.DeliveryChannelName"> <summary> Gets and sets the property DeliveryChannelName. <para> The name of the delivery channel to delete. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DeliverConfigSnapshotRequest"> <summary> Container for the parameters to the DeliverConfigSnapshot operation. Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified. <ul> <li>Notification of starting the delivery.</li> <li>Notification of delivery completed, if the delivery was successfully completed.</li> <li>Notification of delivery failure, if the delivery failed to complete.</li> </ul> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliverConfigSnapshotRequest.DeliveryChannelName"> <summary> Gets and sets the property DeliveryChannelName. <para> The name of the delivery channel through which the snapshot is delivered. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DeliverConfigSnapshotResponse"> <summary> Configuration for accessing Amazon DeliverConfigSnapshot service </summary> </member> <member name="T:Amazon.ConfigService.Model.DeliverConfigSnapshotResult"> <summary> The output for the <a>DeliverConfigSnapshot</a> action in JSON format. </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliverConfigSnapshotResult.ConfigSnapshotId"> <summary> Gets and sets the property ConfigSnapshotId. <para> The ID of the snapshot that is being created. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliverConfigSnapshotResponse.DeliverConfigSnapshotResult"> <summary> Gets and sets the DeliverConfigSnapshotResult property. Represents the output of a DeliverConfigSnapshot operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DeliveryChannel"> <summary> A logical container used for storing the configuration changes of an AWS resource. </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannel.ConfigSnapshotDeliveryProperties"> <summary> Gets and sets the property ConfigSnapshotDeliveryProperties. </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannel.Name"> <summary> Gets and sets the property Name. <para> The name of the delivery channel. By default, AWS Config automatically assigns the name "default" when creating the delivery channel. You cannot change the assigned name. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannel.S3BucketName"> <summary> Gets and sets the property S3BucketName. <para> The name of the Amazon S3 bucket used to store configuration history for the delivery channel. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannel.S3KeyPrefix"> <summary> Gets and sets the property S3KeyPrefix. <para> The prefix for the specified Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannel.SnsTopicARN"> <summary> Gets and sets the property SnsTopicARN. <para> The Amazon Resource Name (ARN) of the SNS topic that AWS Config delivers notifications to. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DeliveryChannelStatus"> <summary> The status of a specified delivery channel. <para> Valid values: <code>Success</code> | <code>Failure</code> </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannelStatus.ConfigHistoryDeliveryInfo"> <summary> Gets and sets the property ConfigHistoryDeliveryInfo. <para> A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannelStatus.ConfigSnapshotDeliveryInfo"> <summary> Gets and sets the property ConfigSnapshotDeliveryInfo. <para> A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannelStatus.ConfigStreamDeliveryInfo"> <summary> Gets and sets the property ConfigStreamDeliveryInfo. <para> A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DeliveryChannelStatus.Name"> <summary> Gets and sets the property Name. <para> The name of the delivery channel. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest"> <summary> Container for the parameters to the DescribeComplianceByConfigRule operation. Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. <para> A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply. </para> <para> If AWS Config has no current evaluation results for the rule, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest.ComplianceTypes"> <summary> Gets and sets the property ComplianceTypes. <para> Filters the results by compliance. </para> <para> The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>INSUFFICIENT_DATA</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest.ConfigRuleNames"> <summary> Gets and sets the property ConfigRuleNames. <para> Specify one or more AWS Config rule names to filter the results by rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResponse"> <summary> Configuration for accessing Amazon DescribeComplianceByConfigRule service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResult.ComplianceByConfigRules"> <summary> Gets and sets the property ComplianceByConfigRules. <para> Indicates whether each of the specified AWS Config rules is compliant. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByConfigRuleResponse.DescribeComplianceByConfigRuleResult"> <summary> Gets and sets the DescribeComplianceByConfigRuleResult property. Represents the output of a DescribeComplianceByConfigRule operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest"> <summary> Container for the parameters to the DescribeComplianceByResource operation. Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. <para> A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. </para> <para> If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource: <ul> <li>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</li> <li>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</li> <li>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</li></ul> </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest.ComplianceTypes"> <summary> Gets and sets the property ComplianceTypes. <para> Filters the results by compliance. </para> <para> The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>INSUFFICIENT_DATA</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceRequest.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The types of AWS resources for which you want compliance information; for example, <code>AWS::EC2::Instance</code>. For this action, you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByResourceResponse"> <summary> Configuration for accessing Amazon DescribeComplianceByResource service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeComplianceByResourceResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceResult.ComplianceByResources"> <summary> Gets and sets the property ComplianceByResources. <para> Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeComplianceByResourceResponse.DescribeComplianceByResourceResult"> <summary> Gets and sets the DescribeComplianceByResourceResult property. Represents the output of a DescribeComplianceByResource operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest"> <summary> Container for the parameters to the DescribeConfigRuleEvaluationStatus operation. Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusRequest.ConfigRuleNames"> <summary> Gets and sets the property ConfigRuleNames. <para> The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResponse"> <summary> Configuration for accessing Amazon DescribeConfigRuleEvaluationStatus service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResult.ConfigRulesEvaluationStatus"> <summary> Gets and sets the property ConfigRulesEvaluationStatus. <para> Status information about your AWS managed Config rules. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRuleEvaluationStatusResponse.DescribeConfigRuleEvaluationStatusResult"> <summary> Gets and sets the DescribeConfigRuleEvaluationStatusResult property. Represents the output of a DescribeConfigRuleEvaluationStatus operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRulesRequest"> <summary> Container for the parameters to the DescribeConfigRules operation. Returns details about your AWS Config rules. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRulesRequest.ConfigRuleNames"> <summary> Gets and sets the property ConfigRuleNames. <para> The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRulesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRulesResponse"> <summary> Configuration for accessing Amazon DescribeConfigRules service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigRulesResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRulesResult.ConfigRules"> <summary> Gets and sets the property ConfigRules. <para> The details about your AWS Config rules. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRulesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigRulesResponse.DescribeConfigRulesResult"> <summary> Gets and sets the DescribeConfigRulesResult property. Represents the output of a DescribeConfigRules operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest"> <summary> Container for the parameters to the DescribeConfigurationRecorders operation. Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account. <note> <para> Currently, you can specify only one configuration recorder per account. </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecordersRequest.ConfigurationRecorderNames"> <summary> Gets and sets the property ConfigurationRecorderNames. <para> A list of configuration recorder names. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecordersResponse"> <summary> Configuration for accessing Amazon DescribeConfigurationRecorders service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecordersResult"> <summary> The output for the <a>DescribeConfigurationRecorders</a> action. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecordersResult.ConfigurationRecorders"> <summary> Gets and sets the property ConfigurationRecorders. <para> A list that contains the descriptions of the specified configuration recorders. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecordersResponse.DescribeConfigurationRecordersResult"> <summary> Gets and sets the DescribeConfigurationRecordersResult property. Represents the output of a DescribeConfigurationRecorders operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest"> <summary> Container for the parameters to the DescribeConfigurationRecorderStatus operation. Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account. <note>Currently, you can specify only one configuration recorder per account.</note> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusRequest.ConfigurationRecorderNames"> <summary> Gets and sets the property ConfigurationRecorderNames. <para> The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResponse"> <summary> Configuration for accessing Amazon DescribeConfigurationRecorderStatus service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResult"> <summary> The output for the <a>DescribeConfigurationRecorderStatus</a> action in JSON format. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResult.ConfigurationRecordersStatus"> <summary> Gets and sets the property ConfigurationRecordersStatus. <para> A list that contains status of the specified recorders. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeConfigurationRecorderStatusResponse.DescribeConfigurationRecorderStatusResult"> <summary> Gets and sets the DescribeConfigurationRecorderStatusResult property. Represents the output of a DescribeConfigurationRecorderStatus operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest"> <summary> Container for the parameters to the DescribeDeliveryChannels operation. Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelsRequest.DeliveryChannelNames"> <summary> Gets and sets the property DeliveryChannelNames. <para> A list of delivery channel names. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelsResponse"> <summary> Configuration for accessing Amazon DescribeDeliveryChannels service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelsResult"> <summary> The output for the <a>DescribeDeliveryChannels</a> action. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelsResult.DeliveryChannels"> <summary> Gets and sets the property DeliveryChannels. <para> A list that contains the descriptions of the specified delivery channel. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelsResponse.DescribeDeliveryChannelsResult"> <summary> Gets and sets the DescribeDeliveryChannelsResult property. Represents the output of a DescribeDeliveryChannels operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest"> <summary> Container for the parameters to the DescribeDeliveryChannelStatus operation. Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. <note>Currently, you can specify only one delivery channel per account.</note> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusRequest.DeliveryChannelNames"> <summary> Gets and sets the property DeliveryChannelNames. <para> A list of delivery channel names. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResponse"> <summary> Configuration for accessing Amazon DescribeDeliveryChannelStatus service </summary> </member> <member name="T:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResult"> <summary> The output for the <a>DescribeDeliveryChannelStatus</a> action. </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResult.DeliveryChannelsStatus"> <summary> Gets and sets the property DeliveryChannelsStatus. <para> A list that contains the status of a specified delivery channel. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.DescribeDeliveryChannelStatusResponse.DescribeDeliveryChannelStatusResult"> <summary> Gets and sets the DescribeDeliveryChannelStatusResult property. Represents the output of a DescribeDeliveryChannelStatus operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.Evaluation"> <summary> Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against. </summary> </member> <member name="P:Amazon.ConfigService.Model.Evaluation.Annotation"> <summary> Gets and sets the property Annotation. <para> Supplementary information about how the evaluation determined the compliance. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Evaluation.ComplianceResourceId"> <summary> Gets and sets the property ComplianceResourceId. <para> The ID of the AWS resource that was evaluated. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Evaluation.ComplianceResourceType"> <summary> Gets and sets the property ComplianceResourceType. <para> The type of AWS resource that was evaluated. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Evaluation.ComplianceType"> <summary> Gets and sets the property ComplianceType. <para> Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against. </para> <para> For the <code>Evaluation</code> data type, AWS Config supports only the <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code> values. AWS Config does not support the <code>INSUFFICIENT_DATA</code> value for this data type. </para> <para> Similarly, AWS Config does not accept <code>INSUFFICIENT_DATA</code> as the value for <code>ComplianceType</code> from a <code>PutEvaluations</code> request. For example, an AWS Lambda function for a custom Config rule cannot pass an <code>INSUFFICIENT_DATA</code> value to AWS Config. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Evaluation.OrderingTimestamp"> <summary> Gets and sets the property OrderingTimestamp. <para> The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.EvaluationResult"> <summary> The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information. </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.Annotation"> <summary> Gets and sets the property Annotation. <para> Supplementary information about how the evaluation determined the compliance. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.ComplianceType"> <summary> Gets and sets the property ComplianceType. <para> Indicates whether the AWS resource complies with the AWS Config rule that evaluated it. </para> <para> For the <code>EvaluationResult</code> data type, AWS Config supports only the <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code> values. AWS Config does not support the <code>INSUFFICIENT_DATA</code> value for the <code>EvaluationResult</code> data type. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.ConfigRuleInvokedTime"> <summary> Gets and sets the property ConfigRuleInvokedTime. <para> The time when the AWS Config rule evaluated the AWS resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.EvaluationResultIdentifier"> <summary> Gets and sets the property EvaluationResultIdentifier. <para> Uniquely identifies the evaluation result. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.ResultRecordedTime"> <summary> Gets and sets the property ResultRecordedTime. <para> The time when AWS Config recorded the evaluation result. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResult.ResultToken"> <summary> Gets and sets the property ResultToken. <para> An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.EvaluationResultIdentifier"> <summary> Uniquely identifies an evaluation result. </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResultIdentifier.EvaluationResultQualifier"> <summary> Gets and sets the property EvaluationResultQualifier. <para> Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResultIdentifier.OrderingTimestamp"> <summary> Gets and sets the property OrderingTimestamp. <para> The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.EvaluationResultQualifier"> <summary> Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated. </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResultQualifier.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name of the AWS Config rule that was used in the evaluation. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResultQualifier.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the evaluated AWS resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.EvaluationResultQualifier.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of AWS resource that was evaluated. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest"> <summary> Container for the parameters to the GetComplianceDetailsByConfigRule operation. Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest.ComplianceTypes"> <summary> Gets and sets the property ComplianceTypes. <para> Filters the results by compliance. </para> <para> The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest.ConfigRuleName"> <summary> Gets and sets the property ConfigRuleName. <para> The name of the AWS Config rule for which you want compliance information. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResponse"> <summary> Configuration for accessing Amazon GetComplianceDetailsByConfigRule service </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResult.EvaluationResults"> <summary> Gets and sets the property EvaluationResults. <para> Indicates whether the AWS resource complies with the specified AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByConfigRuleResponse.GetComplianceDetailsByConfigRuleResult"> <summary> Gets and sets the GetComplianceDetailsByConfigRuleResult property. Represents the output of a GetComplianceDetailsByConfigRule operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest"> <summary> Container for the parameters to the GetComplianceDetailsByResource operation. Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest.ComplianceTypes"> <summary> Gets and sets the property ComplianceTypes. <para> Filters the results by compliance. </para> <para> The allowed values are <code>COMPLIANT</code>, <code>NON_COMPLIANT</code>, and <code>NOT_APPLICABLE</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the AWS resource for which you want compliance information. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceRequest.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of the AWS resource for which you want compliance information. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByResourceResponse"> <summary> Configuration for accessing Amazon GetComplianceDetailsByResource service </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceDetailsByResourceResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceResult.EvaluationResults"> <summary> Gets and sets the property EvaluationResults. <para> Indicates whether the specified AWS resource complies each AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceDetailsByResourceResponse.GetComplianceDetailsByResourceResult"> <summary> Gets and sets the GetComplianceDetailsByResourceResult property. Represents the output of a GetComplianceDetailsByResource operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleRequest"> <summary> Container for the parameters to the GetComplianceSummaryByConfigRule operation. Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResponse"> <summary> Configuration for accessing Amazon GetComplianceSummaryByConfigRule service </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResult.ComplianceSummary"> <summary> Gets and sets the property ComplianceSummary. <para> The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceSummaryByConfigRuleResponse.GetComplianceSummaryByConfigRuleResult"> <summary> Gets and sets the GetComplianceSummaryByConfigRuleResult property. Represents the output of a GetComplianceSummaryByConfigRule operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest"> <summary> Container for the parameters to the GetComplianceSummaryByResourceType operation. Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100. </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeRequest.ResourceTypes"> <summary> Gets and sets the property ResourceTypes. <para> Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type. </para> <para> For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>, and you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResponse"> <summary> Configuration for accessing Amazon GetComplianceSummaryByResourceType service </summary> </member> <member name="T:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResult.ComplianceSummariesByResourceType"> <summary> Gets and sets the property ComplianceSummariesByResourceType. <para> The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetComplianceSummaryByResourceTypeResponse.GetComplianceSummaryByResourceTypeResult"> <summary> Gets and sets the GetComplianceSummaryByResourceTypeResult property. Represents the output of a GetComplianceSummaryByResourceType operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest"> <summary> Container for the parameters to the GetResourceConfigHistory operation. Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. <para> The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> <note> <para> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>. </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.ChronologicalOrder"> <summary> Gets and sets the property ChronologicalOrder. <para> The chronological order for configuration items listed. By default the results are listed in reverse chronological order. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.EarlierTime"> <summary> Gets and sets the property EarlierTime. <para> The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.LaterTime"> <summary> Gets and sets the property LaterTime. <para> The time stamp that indicates a later time. If not specified, current time is taken. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource (for example., <code>sg-xxxxxx</code>). </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryRequest.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The resource type. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.GetResourceConfigHistoryResponse"> <summary> Configuration for accessing Amazon GetResourceConfigHistory service </summary> </member> <member name="T:Amazon.ConfigService.Model.GetResourceConfigHistoryResult"> <summary> The output for the <a>GetResourceConfigHistory</a> action. </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryResult.ConfigurationItems"> <summary> Gets and sets the property ConfigurationItems. <para> A list that contains the configuration history of one or more resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.GetResourceConfigHistoryResponse.GetResourceConfigHistoryResult"> <summary> Gets and sets the GetResourceConfigHistoryResult property. Represents the output of a GetResourceConfigHistory operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InsufficientDeliveryPolicyException.#ctor(System.String)"> <summary> Constructs a new InsufficientDeliveryPolicyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InsufficientPermissionsException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InsufficientPermissionsException.#ctor(System.String)"> <summary> Constructs a new InsufficientPermissionsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidConfigurationRecorderNameException.#ctor(System.String)"> <summary> Constructs a new InvalidConfigurationRecorderNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidDeliveryChannelNameException.#ctor(System.String)"> <summary> Constructs a new InvalidDeliveryChannelNameException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidLimitException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidLimitException.#ctor(System.String)"> <summary> Constructs a new InvalidLimitException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidNextTokenException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.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.ConfigService.Model.InvalidParameterValueException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.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.ConfigService.Model.InvalidRecordingGroupException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidRecordingGroupException.#ctor(System.String)"> <summary> Constructs a new InvalidRecordingGroupException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidResultTokenException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidResultTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidResultTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidRoleException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidRoleException.#ctor(System.String)"> <summary> Constructs a new InvalidRoleException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidS3KeyPrefixException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidS3KeyPrefixException.#ctor(System.String)"> <summary> Constructs a new InvalidS3KeyPrefixException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidSNSTopicARNException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidSNSTopicARNException.#ctor(System.String)"> <summary> Constructs a new InvalidSNSTopicARNException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.InvalidTimeRangeException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.InvalidTimeRangeException.#ctor(System.String)"> <summary> Constructs a new InvalidTimeRangeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.LastDeliveryChannelDeleteFailedException.#ctor(System.String)"> <summary> Constructs a new LastDeliveryChannelDeleteFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest"> <summary> Container for the parameters to the ListDiscoveredResources operation. Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. <note>You can specify either resource IDs or a resource name but not both in the same request.</note> <para> The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.IncludeDeletedResources"> <summary> Gets and sets the property IncludeDeletedResources. <para> Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.ResourceIds"> <summary> Gets and sets the property ResourceIds. <para> The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.ResourceName"> <summary> Gets and sets the property ResourceName. <para> The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesRequest.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of resources that you want AWS Config to list in the response. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ListDiscoveredResourcesResponse"> <summary> Configuration for accessing Amazon ListDiscoveredResources service </summary> </member> <member name="T:Amazon.ConfigService.Model.ListDiscoveredResourcesResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The string that you use in a subsequent request to get the next page of results in a paginated response. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesResult.ResourceIdentifiers"> <summary> Gets and sets the property ResourceIdentifiers. <para> The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ListDiscoveredResourcesResponse.ListDiscoveredResourcesResult"> <summary> Gets and sets the ListDiscoveredResourcesResult property. Represents the output of a ListDiscoveredResources operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.MaxNumberOfConfigRulesExceededException.#ctor(System.String)"> <summary> Constructs a new MaxNumberOfConfigRulesExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.MaxNumberOfConfigurationRecordersExceededException.#ctor(System.String)"> <summary> Constructs a new MaxNumberOfConfigurationRecordersExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.MaxNumberOfDeliveryChannelsExceededException.#ctor(System.String)"> <summary> Constructs a new MaxNumberOfDeliveryChannelsExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoAvailableConfigurationRecorderException.#ctor(System.String)"> <summary> Constructs a new NoAvailableConfigurationRecorderException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoAvailableDeliveryChannelException.#ctor(System.String)"> <summary> Constructs a new NoAvailableDeliveryChannelException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoRunningConfigurationRecorderException.#ctor(System.String)"> <summary> Constructs a new NoRunningConfigurationRecorderException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoSuchBucketException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoSuchBucketException.#ctor(System.String)"> <summary> Constructs a new NoSuchBucketException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoSuchConfigRuleException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoSuchConfigRuleException.#ctor(System.String)"> <summary> Constructs a new NoSuchConfigRuleException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoSuchConfigurationRecorderException.#ctor(System.String)"> <summary> Constructs a new NoSuchConfigurationRecorderException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.NoSuchDeliveryChannelException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.NoSuchDeliveryChannelException.#ctor(System.String)"> <summary> Constructs a new NoSuchDeliveryChannelException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.PutConfigRuleRequest"> <summary> Container for the parameters to the PutConfigRule operation. Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. <para> You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config. </para> <para> If you are adding a new customer managed Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </para> <para> If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules. </para> <para> If you are updating a rule that you have added previously, specify the rule's <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request. </para> <para> The maximum number of rules that AWS Config supports is 25. </para> <para> For more information about developing and using AWS Config rules, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutConfigRuleRequest.ConfigRule"> <summary> Gets and sets the property ConfigRule. </summary> </member> <member name="T:Amazon.ConfigService.Model.PutConfigurationRecorderRequest"> <summary> Container for the parameters to the PutConfigurationRecorder operation. Creates a new configuration recorder to record the selected resource configurations. <para> You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. </para> <note> <para> Currently, you can specify only one configuration recorder per account. </para> <para> If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types. </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutConfigurationRecorderRequest.ConfigurationRecorder"> <summary> Gets and sets the property ConfigurationRecorder. <para> The configuration recorder object that records each configuration change made to the resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.PutDeliveryChannelRequest"> <summary> Container for the parameters to the PutDeliveryChannel operation. Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. <para> You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. </para> <note> <para> Currently, you can specify only one delivery channel per account. </para> </note> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutDeliveryChannelRequest.DeliveryChannel"> <summary> Gets and sets the property DeliveryChannel. <para> The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.PutEvaluationsRequest"> <summary> Container for the parameters to the PutEvaluations operation. Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. </summary> </member> <member name="P:Amazon.ConfigService.Model.PutEvaluationsRequest.Evaluations"> <summary> Gets and sets the property Evaluations. <para> The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutEvaluationsRequest.ResultToken"> <summary> Gets and sets the property ResultToken. <para> An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.PutEvaluationsResponse"> <summary> Configuration for accessing Amazon PutEvaluations service </summary> </member> <member name="T:Amazon.ConfigService.Model.PutEvaluationsResult"> <summary> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutEvaluationsResult.FailedEvaluations"> <summary> Gets and sets the property FailedEvaluations. <para> Requests that failed because of a client or server error. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.PutEvaluationsResponse.PutEvaluationsResult"> <summary> Gets and sets the PutEvaluationsResult property. Represents the output of a PutEvaluations operation. </summary> </member> <member name="T:Amazon.ConfigService.Model.RecordingGroup"> <summary> Specifies the types of AWS resource for which AWS Config records configuration changes. <para> In the recording group, you specify whether all supported types or specific types of resources are recorded. </para> <para> By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes. </para> <para> You can also have AWS Config record configuration changes for supported types of global resources. Global resources are not tied to an individual region and can be used in all regions. </para> <important>The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.</important> <para> If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the <code>resourceTypes</code> parameter. </para> <para> For a list of supported resource types, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported resource types</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/select-resources.html">Selecting Which Resources AWS Config Records</a>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.RecordingGroup.AllSupported"> <summary> Gets and sets the property AllSupported. <para> Specifies whether AWS Config records configuration changes for every supported type of regional resource. </para> <para> If you set this option to <code>true</code>, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type. </para> <para> If you set this option to <code>true</code>, you cannot enumerate a list of <code>resourceTypes</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.RecordingGroup.IncludeGlobalResourceTypes"> <summary> Gets and sets the property IncludeGlobalResourceTypes. <para> Specifies whether AWS Config includes all supported types of global resources with the resources that it records. </para> <para> Before you can set this option to <code>true</code>, you must set the <code>allSupported</code> option to <code>true</code>. </para> <para> If you set this option to <code>true</code>, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.RecordingGroup.ResourceTypes"> <summary> Gets and sets the property ResourceTypes. <para> A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, <code>AWS::EC2::Instance</code> or <code>AWS::CloudTrail::Trail</code>). </para> <para> Before you can set this option to <code>true</code>, you must set the <code>allSupported</code> option to <code>false</code>. </para> <para> If you set this option to <code>true</code>, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. </para> <para> For a list of valid <code>resourceTypes</code> values, see the <b>resourceType Value</b> column in <a href="http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported AWS Resource Types</a>. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.Relationship"> <summary> The relationship of the related resource to the main resource. </summary> </member> <member name="P:Amazon.ConfigService.Model.Relationship.RelationshipName"> <summary> Gets and sets the property RelationshipName. <para> The type of relationship with the related resource. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Relationship.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the related resource (for example, <code>sg-xxxxxx</code>). </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Relationship.ResourceName"> <summary> Gets and sets the property ResourceName. <para> The custom name of the related resource, if available. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Relationship.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The resource type of the related resource. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ResourceIdentifier"> <summary> The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name. </summary> </member> <member name="P:Amazon.ConfigService.Model.ResourceIdentifier.ResourceDeletionTime"> <summary> Gets and sets the property ResourceDeletionTime. <para> The time that the resource was deleted. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ResourceIdentifier.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource (for example., <code>sg-xxxxxx</code>). </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ResourceIdentifier.ResourceName"> <summary> Gets and sets the property ResourceName. <para> The custom name of the resource (if available). </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.ResourceIdentifier.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of resource. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ResourceInUseException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.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.ConfigService.Model.ResourceNotDiscoveredException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.Model.ResourceNotDiscoveredException.#ctor(System.String)"> <summary> Constructs a new ResourceNotDiscoveredException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ConfigService.Model.Scope"> <summary> Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration. </summary> </member> <member name="P:Amazon.ConfigService.Model.Scope.ComplianceResourceId"> <summary> Gets and sets the property ComplianceResourceId. <para> The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for <code>ComplianceResourceTypes</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Scope.ComplianceResourceTypes"> <summary> Gets and sets the property ComplianceResourceTypes. <para> The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for <code>ComplianceResourceId</code>. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Scope.TagKey"> <summary> Gets and sets the property TagKey. <para> The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Scope.TagValue"> <summary> Gets and sets the property TagValue. <para> The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for <code>TagValue</code>, you must also specify a value for <code>TagKey</code>. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.Source"> <summary> Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources. </summary> </member> <member name="P:Amazon.ConfigService.Model.Source.Owner"> <summary> Gets and sets the property Owner. <para> Indicates whether AWS or the customer owns and manages the AWS Config rule. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Source.SourceDetails"> <summary> Gets and sets the property SourceDetails. <para> Provides the source and type of the event that causes AWS Config to evaluate your AWS resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.Source.SourceIdentifier"> <summary> Gets and sets the property SourceIdentifier. <para> For AWS managed Config rules, a pre-defined identifier from a list. To reference the list, see <a href="http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using AWS Managed Config Rules</a>. </para> <para> For customer managed Config rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.SourceDetail"> <summary> Provides the source and type of the event that triggers AWS Config to evaluate your AWS resources against a rule. </summary> </member> <member name="P:Amazon.ConfigService.Model.SourceDetail.EventSource"> <summary> Gets and sets the property EventSource. <para> The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.SourceDetail.MessageType"> <summary> Gets and sets the property MessageType. <para> The type of SNS message that triggers AWS Config to run an evaluation. For evaluations that are initiated when AWS Config delivers a configuration item change notification, you must use <code>ConfigurationItemChangeNotification</code>. For evaluations that are initiated when AWS Config delivers a configuration snapshot, you must use <code>ConfigurationSnapshotDeliveryCompleted</code>. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.StartConfigurationRecorderRequest"> <summary> Container for the parameters to the StartConfigurationRecorder operation. Starts recording configurations of the AWS resources you have selected to record in your AWS account. <para> You must have created at least one delivery channel to successfully start the configuration recorder. </para> </summary> </member> <member name="P:Amazon.ConfigService.Model.StartConfigurationRecorderRequest.ConfigurationRecorderName"> <summary> Gets and sets the property ConfigurationRecorderName. <para> The name of the recorder object that records each configuration change made to the resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.StopConfigurationRecorderRequest"> <summary> Container for the parameters to the StopConfigurationRecorder operation. Stops recording configurations of the AWS resources you have selected to record in your AWS account. </summary> </member> <member name="P:Amazon.ConfigService.Model.StopConfigurationRecorderRequest.ConfigurationRecorderName"> <summary> Gets and sets the property ConfigurationRecorderName. <para> The name of the recorder object that records each configuration change made to the resources. </para> </summary> </member> <member name="T:Amazon.ConfigService.Model.ValidationException"> <summary> ConfigService exception </summary> </member> <member name="M:Amazon.ConfigService.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.ConfigService.Model.Internal.MarshallTransformations.ComplianceByConfigRuleUnmarshaller"> <summary> Response Unmarshaller for ComplianceByConfigRule Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ComplianceByResourceUnmarshaller"> <summary> Response Unmarshaller for ComplianceByResource Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ComplianceContributorCountUnmarshaller"> <summary> Response Unmarshaller for ComplianceContributorCount Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ComplianceSummaryByResourceTypeUnmarshaller"> <summary> Response Unmarshaller for ComplianceSummaryByResourceType Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ComplianceSummaryUnmarshaller"> <summary> Response Unmarshaller for ComplianceSummary Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ComplianceUnmarshaller"> <summary> Response Unmarshaller for Compliance Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigExportDeliveryInfoUnmarshaller"> <summary> Response Unmarshaller for ConfigExportDeliveryInfo Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigRuleEvaluationStatusUnmarshaller"> <summary> Response Unmarshaller for ConfigRuleEvaluationStatus Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigRuleMarshaller"> <summary> ConfigRule Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigRuleUnmarshaller"> <summary> Response Unmarshaller for ConfigRule Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigSnapshotDeliveryPropertiesMarshaller"> <summary> ConfigSnapshotDeliveryProperties Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigSnapshotDeliveryPropertiesUnmarshaller"> <summary> Response Unmarshaller for ConfigSnapshotDeliveryProperties Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigStreamDeliveryInfoUnmarshaller"> <summary> Response Unmarshaller for ConfigStreamDeliveryInfo Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigurationItemUnmarshaller"> <summary> Response Unmarshaller for ConfigurationItem Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigurationRecorderMarshaller"> <summary> ConfigurationRecorder Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigurationRecorderStatusUnmarshaller"> <summary> Response Unmarshaller for ConfigurationRecorderStatus Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ConfigurationRecorderUnmarshaller"> <summary> Response Unmarshaller for ConfigurationRecorder Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeleteConfigRuleRequestMarshaller"> <summary> DeleteConfigRule Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeleteConfigRuleResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteConfigRule operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeleteDeliveryChannelRequestMarshaller"> <summary> DeleteDeliveryChannel Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeleteDeliveryChannelResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDeliveryChannel operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeliverConfigSnapshotRequestMarshaller"> <summary> DeliverConfigSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeliverConfigSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for DeliverConfigSnapshot operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeliveryChannelMarshaller"> <summary> DeliveryChannel Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeliveryChannelStatusUnmarshaller"> <summary> Response Unmarshaller for DeliveryChannelStatus Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DeliveryChannelUnmarshaller"> <summary> Response Unmarshaller for DeliveryChannel Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeComplianceByConfigRuleRequestMarshaller"> <summary> DescribeComplianceByConfigRule Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeComplianceByConfigRuleResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeComplianceByConfigRule operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeComplianceByResourceRequestMarshaller"> <summary> DescribeComplianceByResource Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeComplianceByResourceResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeComplianceByResource operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigRuleEvaluationStatusRequestMarshaller"> <summary> DescribeConfigRuleEvaluationStatus Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigRuleEvaluationStatusResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigRuleEvaluationStatus operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigRulesRequestMarshaller"> <summary> DescribeConfigRules Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigRulesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigRules operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigurationRecordersRequestMarshaller"> <summary> DescribeConfigurationRecorders Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigurationRecordersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationRecorders operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigurationRecorderStatusRequestMarshaller"> <summary> DescribeConfigurationRecorderStatus Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeConfigurationRecorderStatusResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConfigurationRecorderStatus operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeDeliveryChannelsRequestMarshaller"> <summary> DescribeDeliveryChannels Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeDeliveryChannelsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDeliveryChannels operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeDeliveryChannelStatusRequestMarshaller"> <summary> DescribeDeliveryChannelStatus Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.DescribeDeliveryChannelStatusResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDeliveryChannelStatus operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.EvaluationMarshaller"> <summary> Evaluation Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.EvaluationResultIdentifierUnmarshaller"> <summary> Response Unmarshaller for EvaluationResultIdentifier Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.EvaluationResultQualifierUnmarshaller"> <summary> Response Unmarshaller for EvaluationResultQualifier Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.EvaluationResultUnmarshaller"> <summary> Response Unmarshaller for EvaluationResult Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.EvaluationUnmarshaller"> <summary> Response Unmarshaller for Evaluation Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceDetailsByConfigRuleRequestMarshaller"> <summary> GetComplianceDetailsByConfigRule Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceDetailsByConfigRuleResponseUnmarshaller"> <summary> Response Unmarshaller for GetComplianceDetailsByConfigRule operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceDetailsByResourceRequestMarshaller"> <summary> GetComplianceDetailsByResource Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceDetailsByResourceResponseUnmarshaller"> <summary> Response Unmarshaller for GetComplianceDetailsByResource operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceSummaryByConfigRuleRequestMarshaller"> <summary> GetComplianceSummaryByConfigRule Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceSummaryByConfigRuleResponseUnmarshaller"> <summary> Response Unmarshaller for GetComplianceSummaryByConfigRule operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceSummaryByResourceTypeRequestMarshaller"> <summary> GetComplianceSummaryByResourceType Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetComplianceSummaryByResourceTypeResponseUnmarshaller"> <summary> Response Unmarshaller for GetComplianceSummaryByResourceType operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetResourceConfigHistoryRequestMarshaller"> <summary> GetResourceConfigHistory Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.GetResourceConfigHistoryResponseUnmarshaller"> <summary> Response Unmarshaller for GetResourceConfigHistory operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ListDiscoveredResourcesRequestMarshaller"> <summary> ListDiscoveredResources Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ListDiscoveredResourcesResponseUnmarshaller"> <summary> Response Unmarshaller for ListDiscoveredResources operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutConfigRuleRequestMarshaller"> <summary> PutConfigRule Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutConfigRuleResponseUnmarshaller"> <summary> Response Unmarshaller for PutConfigRule operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutConfigurationRecorderRequestMarshaller"> <summary> PutConfigurationRecorder Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutConfigurationRecorderResponseUnmarshaller"> <summary> Response Unmarshaller for PutConfigurationRecorder operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutDeliveryChannelRequestMarshaller"> <summary> PutDeliveryChannel Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutDeliveryChannelResponseUnmarshaller"> <summary> Response Unmarshaller for PutDeliveryChannel operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutEvaluationsRequestMarshaller"> <summary> PutEvaluations Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.PutEvaluationsResponseUnmarshaller"> <summary> Response Unmarshaller for PutEvaluations operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.RecordingGroupMarshaller"> <summary> RecordingGroup Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.RecordingGroupUnmarshaller"> <summary> Response Unmarshaller for RecordingGroup Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.RelationshipUnmarshaller"> <summary> Response Unmarshaller for Relationship Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ResourceIdentifierUnmarshaller"> <summary> Response Unmarshaller for ResourceIdentifier Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ScopeMarshaller"> <summary> Scope Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.ScopeUnmarshaller"> <summary> Response Unmarshaller for Scope Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.SourceDetailMarshaller"> <summary> SourceDetail Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.SourceDetailUnmarshaller"> <summary> Response Unmarshaller for SourceDetail Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.SourceMarshaller"> <summary> Source Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.SourceUnmarshaller"> <summary> Response Unmarshaller for Source Object </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.StartConfigurationRecorderRequestMarshaller"> <summary> StartConfigurationRecorder Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.StartConfigurationRecorderResponseUnmarshaller"> <summary> Response Unmarshaller for StartConfigurationRecorder operation </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.StopConfigurationRecorderRequestMarshaller"> <summary> StopConfigurationRecorder Request Marshaller </summary> </member> <member name="T:Amazon.ConfigService.Model.Internal.MarshallTransformations.StopConfigurationRecorderResponseUnmarshaller"> <summary> Response Unmarshaller for StopConfigurationRecorder operation </summary> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatchClient"> <summary> Implementation for accessing CloudWatch Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications. <para> CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money. </para> <para> In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health. </para> </summary> </member> <member name="T:Amazon.CloudWatch.IAmazonCloudWatch"> <summary> Interface for accessing CloudWatch Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications. <para> CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money. </para> <para> In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health. </para> </summary> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms service method.</param> <returns>The response from the DeleteAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginDeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAlarms operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndDeleteAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAlarms operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAlarms.</param> <returns>Returns a DeleteAlarmsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmHistory"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory service method.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginDescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudWatch.EndDescribeAlarmHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmHistory.</param> <returns>Returns a DescribeAlarmHistoryResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarms"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms service method.</param> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginDescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudWatch.EndDescribeAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarms operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarms.</param> <returns>Returns a DescribeAlarmsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginDescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudWatch.EndDescribeAlarmsForMetric(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAlarmsForMetric operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmsForMetric.</param> <returns>Returns a DescribeAlarmsForMetricResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions service method.</param> <returns>The response from the DisableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginDisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableAlarmActions operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndDisableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAlarmActions.</param> <returns>Returns a DisableAlarmActionsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> Enables actions for the specified alarms. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions service method.</param> <returns>The response from the EnableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginEnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableAlarmActions operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndEnableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAlarmActions.</param> <returns>Returns a EnableAlarmActionsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> Gets statistics for the specified metric. <para> The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. <code>GetMetricStatistics</code> does not return the data in chronological order. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics service method.</param> <returns>The response from the GetMetricStatistics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginGetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudWatch.EndGetMetricStatistics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetMetricStatistics operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetMetricStatistics.</param> <returns>Returns a GetMetricStatisticsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.ListMetrics"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics service method.</param> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonCloudWatch.EndListMetrics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListMetrics operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMetrics.</param> <returns>Returns a ListMetricsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note> <note> If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: <ul> <li><code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on Amazon EC2 instance status metrics.</li> <li><code>ec2:StopInstances</code> for alarms with stop actions.</li> <li><code>ec2:TerminateInstances</code> for alarms with terminate actions.</li> <li><code>ec2:DescribeInstanceRecoveryAttribute</code>, and <code>ec2:RecoverInstances</code> for alarms with recover actions.</li> </ul> <para> If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see <a href="http://docs.aws.amazon.com//IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and Policies</a> in <i>Using IAM</i>. </para> <para> If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. </para> <para> If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm service method.</param> <returns>The response from the PutMetricAlarm service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"> The quota for alarms for this customer has already been reached. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginPutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricAlarm operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndPutMetricAlarm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricAlarm.</param> <returns>Returns a PutMetricAlarmResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the <a>ListMetrics</a> action. <para> Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData service method.</param> <returns>The response from the PutMetricData service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginPutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricData operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndPutMetricData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricData operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricData.</param> <returns>Returns a PutMetricDataResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to <b>ALARM</b> will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <code>DescribeAlarmHistory</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState service method.</param> <returns>The response from the SetAlarmState service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"> Data was not syntactically valid JSON. </exception> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.BeginSetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetAlarmState operation.</returns> </member> <member name="M:Amazon.CloudWatch.IAmazonCloudWatch.EndSetAlarmState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetAlarmState operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetAlarmState.</param> <returns>Returns a SetAlarmStateResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Credentials and an AmazonCloudWatchClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.#ctor(System.String,System.String,System.String,Amazon.CloudWatch.AmazonCloudWatchConfig)"> <summary> Constructs AmazonCloudWatchClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudWatchClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest)"> <summary> Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms service method.</param> <returns>The response from the DeleteAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDeleteAlarms(Amazon.CloudWatch.Model.DeleteAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteAlarms operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteAlarms operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDeleteAlarms(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteAlarms operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteAlarms.</param> <returns>Returns a DeleteAlarmsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest)"> <summary> Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory service method.</param> <returns>The response from the DescribeAlarmHistory service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarmHistory(Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmHistory operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmHistory.</param> <returns>Returns a DescribeAlarmHistoryResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest)"> <summary> Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms service method.</param> <returns>The response from the DescribeAlarms service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidNextTokenException"> The next token specified is invalid. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarms(Amazon.CloudWatch.Model.DescribeAlarmsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarms operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarms operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarms.</param> <returns>Returns a DescribeAlarmsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest)"> <summary> Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric service method.</param> <returns>The response from the DescribeAlarmsForMetric service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDescribeAlarmsForMetric(Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAlarmsForMetric operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAlarmsForMetric operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAlarmsForMetric.</param> <returns>Returns a DescribeAlarmsForMetricResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.DisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest)"> <summary> Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions service method.</param> <returns>The response from the DisableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginDisableAlarmActions(Amazon.CloudWatch.Model.DisableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableAlarmActions operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableAlarmActions operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndDisableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableAlarmActions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableAlarmActions.</param> <returns>Returns a DisableAlarmActionsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest)"> <summary> Enables actions for the specified alarms. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions service method.</param> <returns>The response from the EnableAlarmActions service method, as returned by CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginEnableAlarmActions(Amazon.CloudWatch.Model.EnableAlarmActionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableAlarmActions operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableAlarmActions operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndEnableAlarmActions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableAlarmActions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableAlarmActions.</param> <returns>Returns a EnableAlarmActionsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.GetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest)"> <summary> Gets statistics for the specified metric. <para> The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. <code>GetMetricStatistics</code> does not return the data in chronological order. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics service method.</param> <returns>The response from the GetMetricStatistics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginGetMetricStatistics(Amazon.CloudWatch.Model.GetMetricStatisticsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetMetricStatistics operation. </summary> <param name="request">Container for the necessary parameters to execute the GetMetricStatistics operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetMetricStatistics.</param> <returns>Returns a GetMetricStatisticsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.ListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest)"> <summary> Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics service method.</param> <returns>The response from the ListMetrics service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginListMetrics(Amazon.CloudWatch.Model.ListMetricsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListMetrics operation. </summary> <param name="request">Container for the necessary parameters to execute the ListMetrics operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListMetrics.</param> <returns>Returns a ListMetricsResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest)"> <summary> Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note> <note> If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: <ul> <li><code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on Amazon EC2 instance status metrics.</li> <li><code>ec2:StopInstances</code> for alarms with stop actions.</li> <li><code>ec2:TerminateInstances</code> for alarms with terminate actions.</li> <li><code>ec2:DescribeInstanceRecoveryAttribute</code>, and <code>ec2:RecoverInstances</code> for alarms with recover actions.</li> </ul> <para> If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see <a href="http://docs.aws.amazon.com//IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and Policies</a> in <i>Using IAM</i>. </para> <para> If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. </para> <para> If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm service method.</param> <returns>The response from the PutMetricAlarm service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.LimitExceededException"> The quota for alarms for this customer has already been reached. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginPutMetricAlarm(Amazon.CloudWatch.Model.PutMetricAlarmRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricAlarm operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricAlarm operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndPutMetricAlarm(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricAlarm operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricAlarm.</param> <returns>Returns a PutMetricAlarmResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.PutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest)"> <summary> Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the <a>ListMetrics</a> action. <para> Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData service method.</param> <returns>The response from the PutMetricData service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InternalServiceException"> Indicates that the request processing has failed due to some unknown error, exception, or failure. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterCombinationException"> Parameters that must not be used together were used together. </exception> <exception cref="T:Amazon.CloudWatch.Model.InvalidParameterValueException"> Bad or out-of-range value was supplied for the input parameter. </exception> <exception cref="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> An input parameter that is mandatory for processing the request is not supplied. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginPutMetricData(Amazon.CloudWatch.Model.PutMetricDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricData operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricData operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricData operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndPutMetricData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricData operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricData.</param> <returns>Returns a PutMetricDataResult from CloudWatch.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.SetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest)"> <summary> Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to <b>ALARM</b> will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <code>DescribeAlarmHistory</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState service method.</param> <returns>The response from the SetAlarmState service method, as returned by CloudWatch.</returns> <exception cref="T:Amazon.CloudWatch.Model.InvalidFormatException"> Data was not syntactically valid JSON. </exception> <exception cref="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> The named resource does not exist. </exception> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.BeginSetAlarmState(Amazon.CloudWatch.Model.SetAlarmStateRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetAlarmState operation. </summary> <param name="request">Container for the necessary parameters to execute the SetAlarmState operation on AmazonCloudWatchClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetAlarmState operation.</returns> </member> <member name="M:Amazon.CloudWatch.AmazonCloudWatchClient.EndSetAlarmState(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetAlarmState operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetAlarmState.</param> <returns>Returns a SetAlarmStateResult from CloudWatch.</returns> </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.ComparisonOperator"> <summary> Constants used for properties of type ComparisonOperator. </summary> </member> <member name="F:Amazon.CloudWatch.ComparisonOperator.GreaterThanOrEqualToThreshold"> <summary> Constant GreaterThanOrEqualToThreshold for ComparisonOperator </summary> </member> <member name="F:Amazon.CloudWatch.ComparisonOperator.GreaterThanThreshold"> <summary> Constant GreaterThanThreshold for ComparisonOperator </summary> </member> <member name="F:Amazon.CloudWatch.ComparisonOperator.LessThanOrEqualToThreshold"> <summary> Constant LessThanOrEqualToThreshold for ComparisonOperator </summary> </member> <member name="F:Amazon.CloudWatch.ComparisonOperator.LessThanThreshold"> <summary> Constant LessThanThreshold for ComparisonOperator </summary> </member> <member name="M:Amazon.CloudWatch.ComparisonOperator.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatch.ComparisonOperator.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatch.HistoryItemType"> <summary> Constants used for properties of type HistoryItemType. </summary> </member> <member name="F:Amazon.CloudWatch.HistoryItemType.Action"> <summary> Constant Action for HistoryItemType </summary> </member> <member name="F:Amazon.CloudWatch.HistoryItemType.ConfigurationUpdate"> <summary> Constant ConfigurationUpdate for HistoryItemType </summary> </member> <member name="F:Amazon.CloudWatch.HistoryItemType.StateUpdate"> <summary> Constant StateUpdate for HistoryItemType </summary> </member> <member name="M:Amazon.CloudWatch.HistoryItemType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatch.HistoryItemType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatch.StandardUnit"> <summary> Constants used for properties of type StandardUnit. </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Bits"> <summary> Constant Bits for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.BitsSecond"> <summary> Constant BitsSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Bytes"> <summary> Constant Bytes for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.BytesSecond"> <summary> Constant BytesSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Count"> <summary> Constant Count for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.CountSecond"> <summary> Constant CountSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Gigabits"> <summary> Constant Gigabits for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.GigabitsSecond"> <summary> Constant GigabitsSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Gigabytes"> <summary> Constant Gigabytes for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.GigabytesSecond"> <summary> Constant GigabytesSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Kilobits"> <summary> Constant Kilobits for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.KilobitsSecond"> <summary> Constant KilobitsSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Kilobytes"> <summary> Constant Kilobytes for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.KilobytesSecond"> <summary> Constant KilobytesSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Megabits"> <summary> Constant Megabits for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.MegabitsSecond"> <summary> Constant MegabitsSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Megabytes"> <summary> Constant Megabytes for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.MegabytesSecond"> <summary> Constant MegabytesSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Microseconds"> <summary> Constant Microseconds for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Milliseconds"> <summary> Constant Milliseconds for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.None"> <summary> Constant None for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Percent"> <summary> Constant Percent for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Seconds"> <summary> Constant Seconds for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Terabits"> <summary> Constant Terabits for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.TerabitsSecond"> <summary> Constant TerabitsSecond for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.Terabytes"> <summary> Constant Terabytes for StandardUnit </summary> </member> <member name="F:Amazon.CloudWatch.StandardUnit.TerabytesSecond"> <summary> Constant TerabytesSecond for StandardUnit </summary> </member> <member name="M:Amazon.CloudWatch.StandardUnit.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatch.StandardUnit.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatch.StateValue"> <summary> Constants used for properties of type StateValue. </summary> </member> <member name="F:Amazon.CloudWatch.StateValue.ALARM"> <summary> Constant ALARM for StateValue </summary> </member> <member name="F:Amazon.CloudWatch.StateValue.INSUFFICIENT_DATA"> <summary> Constant INSUFFICIENT_DATA for StateValue </summary> </member> <member name="F:Amazon.CloudWatch.StateValue.OK"> <summary> Constant OK for StateValue </summary> </member> <member name="M:Amazon.CloudWatch.StateValue.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatch.StateValue.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatch.Statistic"> <summary> Constants used for properties of type Statistic. </summary> </member> <member name="F:Amazon.CloudWatch.Statistic.Average"> <summary> Constant Average for Statistic </summary> </member> <member name="F:Amazon.CloudWatch.Statistic.Maximum"> <summary> Constant Maximum for Statistic </summary> </member> <member name="F:Amazon.CloudWatch.Statistic.Minimum"> <summary> Constant Minimum for Statistic </summary> </member> <member name="F:Amazon.CloudWatch.Statistic.SampleCount"> <summary> Constant SampleCount for Statistic </summary> </member> <member name="F:Amazon.CloudWatch.Statistic.Sum"> <summary> Constant Sum for Statistic </summary> </member> <member name="M:Amazon.CloudWatch.Statistic.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatch.Statistic.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatch.Model.AlarmHistoryItem"> <summary> The <code>AlarmHistoryItem</code> data type contains descriptive information about the history of a specific alarm. If you call <a>DescribeAlarmHistory</a>, Amazon CloudWatch returns this data type as part of the DescribeAlarmHistoryResult data type. </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The descriptive name for the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistoryData"> <summary> Gets and sets the property HistoryData. <para> Machine-readable data about the alarm in JSON format. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistoryItemType"> <summary> Gets and sets the property HistoryItemType. <para> The type of alarm history item. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.HistorySummary"> <summary> Gets and sets the property HistorySummary. <para> A human-readable summary of the alarm history. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.AlarmHistoryItem.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time stamp for the alarm history item. </para> </summary> </member> <member name="T:Amazon.CloudWatch.AmazonCloudWatchRequest"> <summary> Base class for CloudWatch operation requests. </summary> </member> <member name="T:Amazon.CloudWatch.Model.Datapoint"> <summary> The <code>Datapoint</code> data type encapsulates the statistical data that Amazon CloudWatch computes from metric data. </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Average"> <summary> Gets and sets the property Average. <para> The average of metric values that correspond to the datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Maximum"> <summary> Gets and sets the property Maximum. <para> The maximum of the metric value used for the datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Minimum"> <summary> Gets and sets the property Minimum. <para> The minimum metric value used for the datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.SampleCount"> <summary> Gets and sets the property SampleCount. <para> The number of metric values that contributed to the aggregate value of this datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Sum"> <summary> Gets and sets the property Sum. <para> The sum of metric values used for the datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time stamp used for the datapoint. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Datapoint.Unit"> <summary> Gets and sets the property Unit. <para> The standard unit used for the datapoint. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DeleteAlarmsRequest"> <summary> Container for the parameters to the DeleteAlarms operation. Deletes all specified alarms. In the event of an error, no alarms are deleted. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DeleteAlarmsRequest.AlarmNames"> <summary> Gets and sets the property AlarmNames. <para> A list of alarms to be deleted. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest"> <summary> Container for the parameters to the DescribeAlarmHistory operation. Retrieves history for the specified alarm. Filter alarms by date range or item type. If an alarm name is not specified, Amazon CloudWatch returns histories for all of the owner's alarms. <note> Amazon CloudWatch retains the history of an alarm for two weeks, whether or not you delete the alarm. </note> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The name of the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.EndDate"> <summary> Gets and sets the property EndDate. <para> The ending date to retrieve alarm history. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.HistoryItemType"> <summary> Gets and sets the property HistoryItemType. <para> The type of alarm histories to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of alarm history records to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.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="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryRequest.StartDate"> <summary> Gets and sets the property StartDate. <para> The starting date to retrieve alarm history. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryResponse"> <summary> Configuration for accessing Amazon DescribeAlarmHistory service </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult"> <summary> The output for the <a>DescribeAlarmHistory</a> action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.AlarmHistoryItems"> <summary> Gets and sets the property AlarmHistoryItems. <para> A list of alarm histories in JSON format. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmHistoryResult.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.CloudWatch.Model.DescribeAlarmHistoryResponse.DescribeAlarmHistoryResult"> <summary> Gets and sets the DescribeAlarmHistoryResult property. Represents the output of a DescribeAlarmHistory operation. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest"> <summary> Container for the parameters to the DescribeAlarmsForMetric operation. Retrieves all alarms for a single metric. Specify a statistic, period, or unit to filter the set of alarms further. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Dimensions"> <summary> Gets and sets the property Dimensions. <para> The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Period"> <summary> Gets and sets the property Period. <para> The period in seconds over which the statistic is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Statistic"> <summary> Gets and sets the property Statistic. <para> The statistic for the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricRequest.Unit"> <summary> Gets and sets the property Unit. <para> The unit for the metric. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResponse"> <summary> Configuration for accessing Amazon DescribeAlarmsForMetric service </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult"> <summary> The output for the <a>DescribeAlarmsForMetric</a> action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResult.MetricAlarms"> <summary> Gets and sets the property MetricAlarms. <para> A list of information for each alarm with the specified metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsForMetricResponse.DescribeAlarmsForMetricResult"> <summary> Gets and sets the DescribeAlarmsForMetricResult property. Represents the output of a DescribeAlarmsForMetric operation. </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsRequest"> <summary> Container for the parameters to the DescribeAlarms operation. Retrieves alarms with the specified names. If no name is specified, all alarms for the user are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.ActionPrefix"> <summary> Gets and sets the property ActionPrefix. <para> The action name prefix. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.AlarmNamePrefix"> <summary> Gets and sets the property AlarmNamePrefix. <para> The alarm name prefix. <code>AlarmNames</code> cannot be specified if this parameter is specified. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.AlarmNames"> <summary> Gets and sets the property AlarmNames. <para> A list of alarm names to retrieve information for. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.MaxRecords"> <summary> Gets and sets the property MaxRecords. <para> The maximum number of alarm descriptions to retrieve. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.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="P:Amazon.CloudWatch.Model.DescribeAlarmsRequest.StateValue"> <summary> Gets and sets the property StateValue. <para> The state value to be used in matching alarms. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsResponse"> <summary> Configuration for accessing Amazon DescribeAlarms service </summary> </member> <member name="T:Amazon.CloudWatch.Model.DescribeAlarmsResult"> <summary> The output for the <a>DescribeAlarms</a> action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsResult.MetricAlarms"> <summary> Gets and sets the property MetricAlarms. <para> A list of information for the specified alarms. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DescribeAlarmsResult.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.CloudWatch.Model.DescribeAlarmsResponse.DescribeAlarmsResult"> <summary> Gets and sets the DescribeAlarmsResult property. Represents the output of a DescribeAlarms operation. </summary> </member> <member name="T:Amazon.CloudWatch.Model.Dimension"> <summary> The <code>Dimension</code> data type further expands on the identity of a metric using a Name, Value pair. <para> For examples that use one or more dimensions, see <a>PutMetricData</a>. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Dimension.Name"> <summary> Gets and sets the property Name. <para> The name of the dimension. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Dimension.Value"> <summary> Gets and sets the property Value. <para> The value representing the dimension measurement </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DimensionFilter"> <summary> The <code>DimensionFilter</code> data type is used to filter <a>ListMetrics</a> results. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DimensionFilter.Name"> <summary> Gets and sets the property Name. <para> The dimension name to be matched. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.DimensionFilter.Value"> <summary> Gets and sets the property Value. <para> The value of the dimension to be matched. </para> <note> Specifying a <code>Name</code> without specifying a <code>Value</code> returns all values associated with that <code>Name</code>. </note> </summary> </member> <member name="T:Amazon.CloudWatch.Model.DisableAlarmActionsRequest"> <summary> Container for the parameters to the DisableAlarmActions operation. Disables actions for the specified alarms. When an alarm's actions are disabled the alarm's state may change, but none of the alarm's actions will execute. </summary> </member> <member name="P:Amazon.CloudWatch.Model.DisableAlarmActionsRequest.AlarmNames"> <summary> Gets and sets the property AlarmNames. <para> The names of the alarms to disable actions for. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.EnableAlarmActionsRequest"> <summary> Container for the parameters to the EnableAlarmActions operation. Enables actions for the specified alarms. </summary> </member> <member name="P:Amazon.CloudWatch.Model.EnableAlarmActionsRequest.AlarmNames"> <summary> Gets and sets the property AlarmNames. <para> The names of the alarms to enable actions for. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsRequest"> <summary> Container for the parameters to the GetMetricStatistics operation. Gets statistics for the specified metric. <para> The maximum number of data points that can be queried is 50,850, whereas the maximum number of data points returned from a single <code>GetMetricStatistics</code> request is 1,440. If you make a request that generates more than 1,440 data points, Amazon CloudWatch returns an error. In such a case, you can alter the request by narrowing the specified time range or increasing the specified period. Alternatively, you can make multiple requests across adjacent time ranges. <code>GetMetricStatistics</code> does not return the data in chronological order. </para> <para> Amazon CloudWatch aggregates data points based on the length of the <code>period</code> that you specify. For example, if you request statistics with a one-minute granularity, Amazon CloudWatch aggregates data points with time stamps that fall within the same one-minute period. In such a case, the data points queried can greatly outnumber the data points returned. </para> <para> The following examples show various statistics allowed by the data point query maximum of 50,850 when you call <code>GetMetricStatistics</code> on Amazon EC2 instances with detailed (one-minute) monitoring enabled: </para> <ul> <li>Statistics for up to 400 instances for a span of one hour</li> <li>Statistics for up to 35 instances over a span of 24 hours</li> <li>Statistics for up to 2 instances over a span of 2 weeks</li> </ul> <para> For information about the namespace, metric names, and dimensions that other Amazon Web Services products use to send metrics to CloudWatch, go to <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html">Amazon CloudWatch Metrics, Namespaces, and Dimensions Reference</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Dimensions"> <summary> Gets and sets the property Dimensions. <para> A list of dimensions describing qualities of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> 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. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z). </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the metric, with or without spaces. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace of the metric, with or without spaces. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Period"> <summary> Gets and sets the property Period. <para> The granularity, in seconds, of the returned datapoints. <code>Period</code> must be at least 60 seconds and must be a multiple of 60. The default value is 60. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> 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. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z). </para> <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. <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </note> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Statistics"> <summary> Gets and sets the property Statistics. <para> The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsRequest.Unit"> <summary> Gets and sets the property Unit. <para> The unit for the metric. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsResponse"> <summary> Configuration for accessing Amazon GetMetricStatistics service </summary> </member> <member name="T:Amazon.CloudWatch.Model.GetMetricStatisticsResult"> <summary> The output for the <a>GetMetricStatistics</a> action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResult.Datapoints"> <summary> Gets and sets the property Datapoints. <para> The datapoints for the specified metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResult.Label"> <summary> Gets and sets the property Label. <para> A label describing the specified metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.GetMetricStatisticsResponse.GetMetricStatisticsResult"> <summary> Gets and sets the GetMetricStatisticsResult property. Represents the output of a GetMetricStatistics operation. </summary> </member> <member name="T:Amazon.CloudWatch.Model.InternalServiceException"> <summary> CloudWatch 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.InvalidFormatException"> <summary> CloudWatch 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> CloudWatch 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> CloudWatch 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> CloudWatch 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> CloudWatch 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. Returns a list of valid metrics stored for the AWS account owner. Returned metrics can be used with <a>GetMetricStatistics</a> to obtain statistical data for a given metric. <note> Up to 500 results are returned for any one call. To retrieve further results, use returned <code>NextToken</code> values with subsequent <code>ListMetrics</code> operations. </note> <note> If you create a metric with the <a>PutMetricData</a> action, allow up to fifteen minutes for the metric to appear in calls to the <code>ListMetrics</code> action. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>. </note> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.Dimensions"> <summary> Gets and sets the property Dimensions. <para> A list of dimensions to filter against. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the metric to filter against. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace to filter against. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsRequest.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.CloudWatch.Model.ListMetricsResponse"> <summary> Configuration for accessing Amazon ListMetrics service </summary> </member> <member name="T:Amazon.CloudWatch.Model.ListMetricsResult"> <summary> The output for the <a>ListMetrics</a> action. </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsResult.Metrics"> <summary> Gets and sets the property Metrics. <para> A list of metrics used to generate statistics for an AWS account. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.ListMetricsResult.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.CloudWatch.Model.ListMetricsResponse.ListMetricsResult"> <summary> Gets and sets the ListMetricsResult property. Represents the output of a ListMetrics operation. </summary> </member> <member name="T:Amazon.CloudWatch.Model.Metric"> <summary> The <code>Metric</code> data type contains information about a specific metric. If you call <a>ListMetrics</a>, Amazon CloudWatch returns information contained by this data type. <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="P:Amazon.CloudWatch.Model.Metric.Dimensions"> <summary> Gets and sets the property Dimensions. <para> A list of dimensions associated with the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Metric.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.Metric.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace of the metric. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MetricAlarm"> <summary> The <a>MetricAlarm</a> data type represents an alarm. You can use <a>PutMetricAlarm</a> to create or update an alarm. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.ActionsEnabled"> <summary> Gets and sets the property ActionsEnabled. <para> Indicates whether actions should be executed during any changes to the alarm's state. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmActions"> <summary> Gets and sets the property AlarmActions. <para> The list of actions to execute when this alarm transitions into an <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmArn"> <summary> Gets and sets the property AlarmArn. <para> The Amazon Resource Name (ARN) of the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmConfigurationUpdatedTimestamp"> <summary> Gets and sets the property AlarmConfigurationUpdatedTimestamp. <para> The time stamp of the last update to the alarm configuration. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmDescription"> <summary> Gets and sets the property AlarmDescription. <para> The description for the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The name of the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.ComparisonOperator"> <summary> Gets and sets the property ComparisonOperator. <para> The arithmetic operation to use when comparing the specified <code>Statistic</code> and <code>Threshold</code>. The specified <code>Statistic</code> value is used as the first operand. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Dimensions"> <summary> Gets and sets the property Dimensions. <para> The list of dimensions associated with the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.EvaluationPeriods"> <summary> Gets and sets the property EvaluationPeriods. <para> The number of periods over which data is compared to the specified threshold. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.InsufficientDataActions"> <summary> Gets and sets the property InsufficientDataActions. <para> The list of actions to execute when this alarm transitions into an <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> <important>The current WSDL lists this attribute as <code>UnknownActions</code>.</important> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the alarm's metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace of alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.OKActions"> <summary> Gets and sets the property OKActions. <para> The list of actions to execute when this alarm transitions into an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Period"> <summary> Gets and sets the property Period. <para> The period in seconds over which the statistic is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateReason"> <summary> Gets and sets the property StateReason. <para> A human-readable explanation for the alarm's state. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateReasonData"> <summary> Gets and sets the property StateReasonData. <para> An explanation for the alarm's state in machine-readable JSON format </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateUpdatedTimestamp"> <summary> Gets and sets the property StateUpdatedTimestamp. <para> The time stamp of the last update to the alarm's state. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.StateValue"> <summary> Gets and sets the property StateValue. <para> The state value for the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Statistic"> <summary> Gets and sets the property Statistic. <para> The statistic to apply to the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Threshold"> <summary> Gets and sets the property Threshold. <para> The value against which the specified statistic is compared. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricAlarm.Unit"> <summary> Gets and sets the property Unit. <para> The unit of the alarm's associated metric. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MetricDatum"> <summary> The <code>MetricDatum</code> data type encapsulates the information sent with <a>PutMetricData</a> to either create a new metric or add new values to be aggregated into an existing metric. </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Dimensions"> <summary> Gets and sets the property Dimensions. <para> 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> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.MetricName"> <summary> Gets and sets the property MetricName. <para> The name of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.StatisticValues"> <summary> Gets and sets the property StatisticValues. <para> A set of statistical values describing the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Unit"> <summary> Gets and sets the property Unit. <para> The unit of the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.MetricDatum.Value"> <summary> Gets and sets the property Value. <para> The value for the metric. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> </summary> </member> <member name="T:Amazon.CloudWatch.Model.MissingRequiredParameterException"> <summary> CloudWatch 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. Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric. Optionally, this operation can associate one or more Amazon Simple Notification Service resources with the alarm. <para> When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its <code>StateValue</code> is set appropriately. Any actions associated with the <code>StateValue</code> is then executed. </para> <note> When updating an existing alarm, its <code>StateValue</code> is left unchanged. </note> <note> If you are using an AWS Identity and Access Management (IAM) account to create or modify an alarm, you must have the following Amazon EC2 permissions: <ul> <li><code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on Amazon EC2 instance status metrics.</li> <li><code>ec2:StopInstances</code> for alarms with stop actions.</li> <li><code>ec2:TerminateInstances</code> for alarms with terminate actions.</li> <li><code>ec2:DescribeInstanceRecoveryAttribute</code>, and <code>ec2:RecoverInstances</code> for alarms with recover actions.</li> </ul> <para> If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm but the stop or terminate actions won't be performed on the Amazon EC2 instance. However, if you are later granted permission to use the associated Amazon EC2 APIs, the alarm actions you created earlier will be performed. For more information about IAM permissions, see <a href="http://docs.aws.amazon.com//IAM/latest/UserGuide/PermissionsAndPolicies.html">Permissions and Policies</a> in <i>Using IAM</i>. </para> <para> If you are using an IAM role (e.g., an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. </para> <para> If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions. </para> </note> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.ActionsEnabled"> <summary> Gets and sets the property ActionsEnabled. <para> Indicates whether or not actions should be executed during any changes to the alarm's state. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmActions"> <summary> Gets and sets the property AlarmActions. <para> The list of actions to execute when this alarm transitions into an <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> <para> Valid Values: arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:stop | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:terminate | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:recover </para> <para> Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 </para> <para> <b>Note:</b> You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the <b>EC2ActionsAccess</b> IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmDescription"> <summary> Gets and sets the property AlarmDescription. <para> The description for the alarm. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The descriptive name for the alarm. This name must be unique within the user's AWS account </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.ComparisonOperator"> <summary> Gets and sets the property ComparisonOperator. <para> The arithmetic operation to use when comparing the specified <code>Statistic</code> and <code>Threshold</code>. The specified <code>Statistic</code> value is used as the first operand. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Dimensions"> <summary> Gets and sets the property Dimensions. <para> The dimensions for the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.EvaluationPeriods"> <summary> Gets and sets the property EvaluationPeriods. <para> The number of periods over which data is compared to the specified threshold. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.InsufficientDataActions"> <summary> Gets and sets the property InsufficientDataActions. <para> The list of actions to execute when this alarm transitions into an <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> <para> Valid Values: arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:stop | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:terminate | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:recover </para> <para> Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 </para> <para> <b>Note:</b> You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the <b>EC2ActionsAccess</b> IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.MetricName"> <summary> Gets and sets the property MetricName. <para> The name for the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace for the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.OKActions"> <summary> Gets and sets the property OKActions. <para> The list of actions to execute when this alarm transitions into an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN). </para> <para> Valid Values: arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:stop | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:terminate | arn:aws:automate:<i>region (e.g., us-east-1)</i>:ec2:recover </para> <para> Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 </para> <para> <b>Note:</b> You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the <b>EC2ActionsAccess</b> IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Period"> <summary> Gets and sets the property Period. <para> The period in seconds over which the specified statistic is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Statistic"> <summary> Gets and sets the property Statistic. <para> The statistic to apply to the alarm's associated metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Threshold"> <summary> Gets and sets the property Threshold. <para> The value against which the specified statistic is compared. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricAlarmRequest.Unit"> <summary> Gets and sets the property Unit. <para> The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. </para> <para> <b>Note:</b> If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.PutMetricDataRequest"> <summary> Container for the parameters to the PutMetricData operation. Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to the <a>ListMetrics</a> action. <para> Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests. </para> <important>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported. </important> <para> Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using <code>GetMetricStatistics</code>. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricDataRequest.MetricData"> <summary> Gets and sets the property MetricData. <para> A list of data describing the metric. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.PutMetricDataRequest.Namespace"> <summary> Gets and sets the property Namespace. <para> The namespace for the metric data. </para> <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> </summary> </member> <member name="T:Amazon.CloudWatch.Model.ResourceNotFoundException"> <summary> CloudWatch 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. Temporarily sets the state of an alarm. When the updated <code>StateValue</code> differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to <b>ALARM</b> will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <code>DescribeAlarmHistory</code>. </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.AlarmName"> <summary> Gets and sets the property AlarmName. <para> The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateReason"> <summary> Gets and sets the property StateReason. <para> The reason that this alarm is set to this specific state (in human-readable text format) </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateReasonData"> <summary> Gets and sets the property StateReasonData. <para> The reason that this alarm is set to this specific state (in machine-readable JSON format) </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.SetAlarmStateRequest.StateValue"> <summary> Gets and sets the property StateValue. <para> The value of the state. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.StatisticSet"> <summary> The <code>StatisticSet</code> data type describes the <code>StatisticValues</code> component of <a>MetricDatum</a>, and represents a set of statistics that describes a specific metric. </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Maximum"> <summary> Gets and sets the property Maximum. <para> The maximum value of the sample set. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Minimum"> <summary> Gets and sets the property Minimum. <para> The minimum value of the sample set. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.SampleCount"> <summary> Gets and sets the property SampleCount. <para> The number of samples used for the statistic set. </para> </summary> </member> <member name="P:Amazon.CloudWatch.Model.StatisticSet.Sum"> <summary> Gets and sets the property Sum. <para> The sum of values for the sample set. </para> </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.AlarmHistoryItemUnmarshaller"> <summary> Response Unmarshaller for AlarmHistoryItem Object </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DatapointUnmarshaller"> <summary> Response Unmarshaller for Datapoint Object </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DeleteAlarmsRequestMarshaller"> <summary> DeleteAlarms 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> DescribeAlarmHistory 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.DescribeAlarmsForMetricRequestMarshaller"> <summary> DescribeAlarmsForMetric 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.DescribeAlarmsRequestMarshaller"> <summary> DescribeAlarms 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.DimensionUnmarshaller"> <summary> Response Unmarshaller for Dimension Object </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.DisableAlarmActionsRequestMarshaller"> <summary> DisableAlarmActions 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> EnableAlarmActions 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> GetMetricStatistics 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.ListMetricsRequestMarshaller"> <summary> ListMetrics 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.MetricAlarmUnmarshaller"> <summary> Response Unmarshaller for MetricAlarm Object </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.MetricUnmarshaller"> <summary> Response Unmarshaller for Metric Object </summary> </member> <member name="T:Amazon.CloudWatch.Model.Internal.MarshallTransformations.PutMetricAlarmRequestMarshaller"> <summary> PutMetricAlarm 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> PutMetricData 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> SetAlarmState 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.CloudWatchLogs.AmazonCloudWatchLogsClient"> <summary> Implementation for accessing CloudWatchLogs Amazon CloudWatch Logs API Reference <para> You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK. </para> <para> You can use CloudWatch Logs to: </para> <ul> <li> <para> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify. </para> </li> <li> <para> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting. </para> </li> <li> <para> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it. </para> </li> </ul> </summary> </member> <member name="T:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs"> <summary> Interface for accessing CloudWatchLogs Amazon CloudWatch Logs API Reference <para> You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK. </para> <para> You can use CloudWatch Logs to: </para> <ul> <li> <para> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify. </para> </li> <li> <para> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting. </para> </li> <li> <para> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it. </para> </li> </ul> </summary> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest)"> <summary> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidOperationException"> Returned if the operation is not valid on the specified resource </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginCancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelExportTask operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndCancelExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelExportTask.</param> <returns>Returns a CancelExportTaskResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest)"> <summary> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account. </para> <para> You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask service method.</param> <returns>The response from the CreateExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginCreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateExportTask operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndCreateExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateExportTask.</param> <returns>Returns a CreateExportTaskResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest)"> <summary> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup service method.</param> <returns>The response from the CreateLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginCreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLogGroup operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndCreateLogGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLogGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLogGroup.</param> <returns>Returns a CreateLogGroupResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.CreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest)"> <summary> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream service method.</param> <returns>The response from the CreateLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginCreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLogStream operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndCreateLogStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLogStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLogStream.</param> <returns>Returns a CreateLogStreamResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest)"> <summary> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination service method.</param> <returns>The response from the DeleteDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDestination operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteDestination(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDestination operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDestination.</param> <returns>Returns a DeleteDestinationResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest)"> <summary> Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup service method.</param> <returns>The response from the DeleteLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLogGroup operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteLogGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLogGroup.</param> <returns>Returns a DeleteLogGroupResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest)"> <summary> Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream service method.</param> <returns>The response from the DeleteLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLogStream operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteLogStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLogStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLogStream.</param> <returns>Returns a DeleteLogStreamResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest)"> <summary> Deletes a metric filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter service method.</param> <returns>The response from the DeleteMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteMetricFilter.</param> <returns>Returns a DeleteMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest)"> <summary> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy service method.</param> <returns>The response from the DeleteRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRetentionPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteRetentionPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRetentionPolicy.</param> <returns>Returns a DeleteRetentionPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest)"> <summary> Deletes a subscription filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter service method.</param> <returns>The response from the DeleteSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSubscriptionFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDeleteSubscriptionFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSubscriptionFilter.</param> <returns>Returns a DeleteSubscriptionFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest)"> <summary> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations service method.</param> <returns>The response from the DescribeDestinations service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDestinations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDestinations operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeDestinations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDestinations operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDestinations.</param> <returns>Returns a DescribeDestinationsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest)"> <summary> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExportTasks operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeExportTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExportTasks.</param> <returns>Returns a DescribeExportTasksResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogGroups"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest)"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups service method.</param> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLogGroups operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeLogGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLogGroups.</param> <returns>Returns a DescribeLogGroupsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest)"> <summary> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams service method.</param> <returns>The response from the DescribeLogStreams service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLogStreams operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeLogStreams(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLogStreams.</param> <returns>Returns a DescribeLogStreamsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest)"> <summary> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters service method.</param> <returns>The response from the DescribeMetricFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMetricFilters operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeMetricFilters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMetricFilters.</param> <returns>Returns a DescribeMetricFiltersResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.DescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest)"> <summary> Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters service method.</param> <returns>The response from the DescribeSubscriptionFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginDescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSubscriptionFilters operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndDescribeSubscriptionFilters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSubscriptionFilters.</param> <returns>Returns a DescribeSubscriptionFiltersResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.FilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest)"> <summary> Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents service method.</param> <returns>The response from the FilterLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginFilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the FilterLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndFilterLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndFilterLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the FilterLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginFilterLogEvents.</param> <returns>Returns a FilterLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.GetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest)"> <summary> Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents service method.</param> <returns>The response from the GetLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginGetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndGetLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLogEvents.</param> <returns>Returns a GetLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest)"> <summary> Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutDestination service method.</param> <returns>The response from the PutDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestination operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDestination operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutDestination(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDestination operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDestination.</param> <returns>Returns a PutDestinationResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest)"> <summary> Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy service method.</param> <returns>The response from the PutDestinationPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDestinationPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutDestinationPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDestinationPolicy.</param> <returns>Returns a PutDestinationPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest)"> <summary> Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para> <para> The batch of events must satisfy the following constraints: <ul> <li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li> <li>None of the log events in the batch can be more than 2 hours in the future.</li> <li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li> <li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li> <li>The maximum number of log events in a batch is 10,000.</li> <li>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents service method.</param> <returns>The response from the PutLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutLogEvents.</param> <returns>Returns a PutLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest)"> <summary> Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter service method.</param> <returns>The response from the PutMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricFilter.</param> <returns>Returns a PutMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest)"> <summary> Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy service method.</param> <returns>The response from the PutRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutRetentionPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutRetentionPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutRetentionPolicy.</param> <returns>Returns a PutRetentionPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.PutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest)"> <summary> Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> <para> Currently there can only be one subscription filter associated with a log group. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter service method.</param> <returns>The response from the PutSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginPutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutSubscriptionFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndPutSubscriptionFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutSubscriptionFilter.</param> <returns>Returns a PutSubscriptionFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.TestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest)"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter service method.</param> <returns>The response from the TestMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.BeginTestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TestMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTestMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.IAmazonCloudWatchLogs.EndTestMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TestMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTestMetricFilter.</param> <returns>Returns a TestMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.#ctor(System.String,System.String,System.String,Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig)"> <summary> Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonCloudWatchLogsClient Configuration Object</param> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest)"> <summary> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidOperationException"> Returned if the operation is not valid on the specified resource </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginCancelExportTask(Amazon.CloudWatchLogs.Model.CancelExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelExportTask operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndCancelExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelExportTask.</param> <returns>Returns a CancelExportTaskResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest)"> <summary> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account. </para> <para> You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask service method.</param> <returns>The response from the CreateExportTask service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginCreateExportTask(Amazon.CloudWatchLogs.Model.CreateExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateExportTask operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateExportTask operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndCreateExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateExportTask.</param> <returns>Returns a CreateExportTaskResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest)"> <summary> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup service method.</param> <returns>The response from the CreateLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginCreateLogGroup(Amazon.CloudWatchLogs.Model.CreateLogGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogGroup operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLogGroup operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndCreateLogGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLogGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLogGroup.</param> <returns>Returns a CreateLogGroupResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.CreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest)"> <summary> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream service method.</param> <returns>The response from the CreateLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> Returned if the specified resource already exists. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginCreateLogStream(Amazon.CloudWatchLogs.Model.CreateLogStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateLogStream operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLogStream operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndCreateLogStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateLogStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateLogStream.</param> <returns>Returns a CreateLogStreamResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest)"> <summary> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination service method.</param> <returns>The response from the DeleteDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteDestination(Amazon.CloudWatchLogs.Model.DeleteDestinationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDestination operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDestination operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteDestination(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDestination operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDestination.</param> <returns>Returns a DeleteDestinationResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest)"> <summary> Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup service method.</param> <returns>The response from the DeleteLogGroup service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteLogGroup(Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogGroup operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLogGroup operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteLogGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLogGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLogGroup.</param> <returns>Returns a DeleteLogGroupResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest)"> <summary> Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream service method.</param> <returns>The response from the DeleteLogStream service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteLogStream(Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteLogStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteLogStream operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLogStream operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteLogStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteLogStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteLogStream.</param> <returns>Returns a DeleteLogStreamResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest)"> <summary> Deletes a metric filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter service method.</param> <returns>The response from the DeleteMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteMetricFilter(Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteMetricFilter.</param> <returns>Returns a DeleteMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest)"> <summary> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy service method.</param> <returns>The response from the DeleteRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteRetentionPolicy(Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRetentionPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRetentionPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteRetentionPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRetentionPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRetentionPolicy.</param> <returns>Returns a DeleteRetentionPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest)"> <summary> Deletes a subscription filter associated with the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter service method.</param> <returns>The response from the DeleteSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDeleteSubscriptionFilter(Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubscriptionFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSubscriptionFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDeleteSubscriptionFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSubscriptionFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSubscriptionFilter.</param> <returns>Returns a DeleteSubscriptionFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest)"> <summary> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations service method.</param> <returns>The response from the DescribeDestinations service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeDestinations(Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDestinations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDestinations operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDestinations operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeDestinations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDestinations operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDestinations.</param> <returns>Returns a DescribeDestinationsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest)"> <summary> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeExportTasks(Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExportTasks operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeExportTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExportTasks.</param> <returns>Returns a DescribeExportTasksResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogGroups"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest)"> <summary> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups service method.</param> <returns>The response from the DescribeLogGroups service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeLogGroups(Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogGroups operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLogGroups operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeLogGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLogGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLogGroups.</param> <returns>Returns a DescribeLogGroupsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest)"> <summary> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams service method.</param> <returns>The response from the DescribeLogStreams service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeLogStreams(Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLogStreams operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLogStreams operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeLogStreams(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLogStreams operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLogStreams.</param> <returns>Returns a DescribeLogStreamsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest)"> <summary> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters service method.</param> <returns>The response from the DescribeMetricFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeMetricFilters(Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMetricFilters operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMetricFilters operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeMetricFilters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMetricFilters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMetricFilters.</param> <returns>Returns a DescribeMetricFiltersResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.DescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest)"> <summary> Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters service method.</param> <returns>The response from the DescribeSubscriptionFilters service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginDescribeSubscriptionFilters(Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubscriptionFilters operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSubscriptionFilters operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndDescribeSubscriptionFilters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSubscriptionFilters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSubscriptionFilters.</param> <returns>Returns a DescribeSubscriptionFiltersResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.FilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest)"> <summary> Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents service method.</param> <returns>The response from the FilterLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginFilterLogEvents(Amazon.CloudWatchLogs.Model.FilterLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the FilterLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the FilterLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndFilterLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndFilterLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the FilterLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginFilterLogEvents.</param> <returns>Returns a FilterLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.GetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest)"> <summary> Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents service method.</param> <returns>The response from the GetLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginGetLogEvents(Amazon.CloudWatchLogs.Model.GetLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the GetLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndGetLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetLogEvents.</param> <returns>Returns a GetLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest)"> <summary> Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutDestination service method.</param> <returns>The response from the PutDestination service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutDestination(Amazon.CloudWatchLogs.Model.PutDestinationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDestination operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestination operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDestination operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutDestination(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDestination operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDestination.</param> <returns>Returns a PutDestinationResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest)"> <summary> Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy service method.</param> <returns>The response from the PutDestinationPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutDestinationPolicy(Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutDestinationPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutDestinationPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutDestinationPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutDestinationPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutDestinationPolicy.</param> <returns>Returns a PutDestinationPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest)"> <summary> Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para> <para> The batch of events must satisfy the following constraints: <ul> <li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li> <li>None of the log events in the batch can be more than 2 hours in the future.</li> <li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li> <li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li> <li>The maximum number of log events in a batch is 10,000.</li> <li>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</li> </ul> </para> </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents service method.</param> <returns>The response from the PutLogEvents service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException"> </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutLogEvents(Amazon.CloudWatchLogs.Model.PutLogEventsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutLogEvents operation. </summary> <param name="request">Container for the necessary parameters to execute the PutLogEvents operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutLogEvents operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutLogEvents(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutLogEvents operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutLogEvents.</param> <returns>Returns a PutLogEventsResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest)"> <summary> Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter service method.</param> <returns>The response from the PutMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutMetricFilter(Amazon.CloudWatchLogs.Model.PutMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutMetricFilter.</param> <returns>Returns a PutMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest)"> <summary> Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy service method.</param> <returns>The response from the PutRetentionPolicy service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutRetentionPolicy(Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="request">Container for the necessary parameters to execute the PutRetentionPolicy operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutRetentionPolicy operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutRetentionPolicy(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutRetentionPolicy operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutRetentionPolicy.</param> <returns>Returns a PutRetentionPolicyResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.PutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest)"> <summary> Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> <para> Currently there can only be one subscription filter associated with a log group. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter service method.</param> <returns>The response from the PutSubscriptionFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> Returned if you have reached the maximum number of resources that can be created. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> Returned if multiple requests to update the same resource were in conflict. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> Returned if the specified resource does not exist. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginPutSubscriptionFilter(Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the PutSubscriptionFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPutSubscriptionFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndPutSubscriptionFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutSubscriptionFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutSubscriptionFilter.</param> <returns>Returns a PutSubscriptionFilterResult from CloudWatchLogs.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.TestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest)"> <summary> Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter service method.</param> <returns>The response from the TestMetricFilter service method, as returned by CloudWatchLogs.</returns> <exception cref="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> Returned if a parameter of the request is incorrectly specified. </exception> <exception cref="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> Returned if the service cannot complete the request. </exception> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.BeginTestMetricFilter(Amazon.CloudWatchLogs.Model.TestMetricFilterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TestMetricFilter operation. </summary> <param name="request">Container for the necessary parameters to execute the TestMetricFilter operation on AmazonCloudWatchLogsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTestMetricFilter operation.</returns> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsClient.EndTestMetricFilter(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TestMetricFilter operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTestMetricFilter.</param> <returns>Returns a TestMetricFilterResult from CloudWatchLogs.</returns> </member> <member name="T:Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig"> <summary> Configuration for accessing Amazon CloudWatchLogs service </summary> </member> <member name="M:Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.CloudWatchLogs.AmazonCloudWatchLogsConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.CloudWatchLogs.ExportTaskStatusCode"> <summary> Constants used for properties of type ExportTaskStatusCode. </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.CANCELLED"> <summary> Constant CANCELLED for ExportTaskStatusCode </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.COMPLETED"> <summary> Constant COMPLETED for ExportTaskStatusCode </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.FAILED"> <summary> Constant FAILED for ExportTaskStatusCode </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.PENDING"> <summary> Constant PENDING for ExportTaskStatusCode </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.PENDING_CANCEL"> <summary> Constant PENDING_CANCEL for ExportTaskStatusCode </summary> </member> <member name="F:Amazon.CloudWatchLogs.ExportTaskStatusCode.RUNNING"> <summary> Constant RUNNING for ExportTaskStatusCode </summary> </member> <member name="M:Amazon.CloudWatchLogs.ExportTaskStatusCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatchLogs.ExportTaskStatusCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatchLogs.OrderBy"> <summary> Constants used for properties of type OrderBy. </summary> </member> <member name="F:Amazon.CloudWatchLogs.OrderBy.LastEventTime"> <summary> Constant LastEventTime for OrderBy </summary> </member> <member name="F:Amazon.CloudWatchLogs.OrderBy.LogStreamName"> <summary> Constant LogStreamName for OrderBy </summary> </member> <member name="M:Amazon.CloudWatchLogs.OrderBy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.CloudWatchLogs.OrderBy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest"> <summary> Base class for CloudWatchLogs operation requests. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CancelExportTaskRequest"> <summary> Container for the parameters to the CancelExportTask operation. Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CancelExportTaskRequest.TaskId"> <summary> Gets and sets the property TaskId. <para> Id of the export task to cancel. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest"> <summary> Container for the parameters to the CreateExportTask operation. Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. <para> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. You can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time, per account. </para> <para> You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.Destination"> <summary> Gets and sets the property Destination. <para> Name of Amazon S3 bucket to which the log data will be exported. </para> <para> <b>Note:</b> Only buckets in the same AWS region are supported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.DestinationPrefix"> <summary> Gets and sets the property DestinationPrefix. <para> Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.From"> <summary> Gets and sets the property From. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the start time of the range for the request. Events with a timestamp prior to this time will not be exported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to export. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.LogStreamNamePrefix"> <summary> Gets and sets the property LogStreamNamePrefix. <para> Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.TaskName"> <summary> Gets and sets the property TaskName. <para> The name of the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskRequest.To"> <summary> Gets and sets the property To. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. It indicates the end time of the range for the request. Events with a timestamp later than this time will not be exported. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CreateExportTaskResponse"> <summary> Configuration for accessing Amazon CreateExportTask service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CreateExportTaskResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskResult.TaskId"> <summary> Gets and sets the property TaskId. <para> Id of the export task that got created. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateExportTaskResponse.CreateExportTaskResult"> <summary> Gets and sets the CreateExportTaskResult property. Represents the output of a CreateExportTask operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CreateLogGroupRequest"> <summary> Container for the parameters to the CreateLogGroup operation. Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. <para> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.CreateLogGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.CreateLogGroupRequest.#ctor(System.String)"> <summary> Instantiates CreateLogGroupRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to create.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateLogGroupRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to create. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.CreateLogStreamRequest"> <summary> Container for the parameters to the CreateLogStream operation. Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. <para> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.CreateLogStreamRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.CreateLogStreamRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateLogStreamRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group under which the log stream is to be created.</param> <param name="logStreamName">The name of the log stream to create.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateLogStreamRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group under which the log stream is to be created. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.CreateLogStreamRequest.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream to create. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DataAlreadyAcceptedException.#ctor(System.String)"> <summary> Constructs a new DataAlreadyAcceptedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteDestinationRequest"> <summary> Container for the parameters to the DeleteDestination operation. Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteDestinationRequest.DestinationName"> <summary> Gets and sets the property DestinationName. <para> The name of destination to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest"> <summary> Container for the parameters to the DeleteLogGroup operation. Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest.#ctor(System.String)"> <summary> Instantiates DeleteLogGroupRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to delete.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteLogGroupRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest"> <summary> Container for the parameters to the DeleteLogStream operation. Deletes a log stream and permanently deletes all the archived log events associated with it. </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest.#ctor(System.String,System.String)"> <summary> Instantiates DeleteLogStreamRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group under which the log stream to delete belongs.</param> <param name="logStreamName">The name of the log stream to delete.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group under which the log stream to delete belongs. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteLogStreamRequest.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest"> <summary> Container for the parameters to the DeleteMetricFilter operation. Deletes a metric filter associated with the specified log group. </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest.#ctor(System.String,System.String)"> <summary> Instantiates DeleteMetricFilterRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group that is associated with the metric filter to delete.</param> <param name="filterName">The name of the metric filter to delete.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest.FilterName"> <summary> Gets and sets the property FilterName. <para> The name of the metric filter to delete. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteMetricFilterRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group that is associated with the metric filter to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest"> <summary> Container for the parameters to the DeleteRetentionPolicy operation. Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest.#ctor(System.String)"> <summary> Instantiates DeleteRetentionPolicyRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group that is associated with the retention policy to delete.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteRetentionPolicyRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group that is associated with the retention policy to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest"> <summary> Container for the parameters to the DeleteSubscriptionFilter operation. Deletes a subscription filter associated with the specified log group. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest.FilterName"> <summary> Gets and sets the property FilterName. <para> The name of the subscription filter to delete. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DeleteSubscriptionFilterRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group that is associated with the subscription filter to delete. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest"> <summary> Container for the parameters to the DescribeDestinations operation. Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. <para> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest.DestinationNamePrefix"> <summary> Gets and sets the property DestinationNamePrefix. <para> Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest.Limit"> <summary> Gets and sets the property Limit. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsRequest.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse"> <summary> Configuration for accessing Amazon DescribeDestinations service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeDestinationsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsResult.Destinations"> <summary> Gets and sets the property Destinations. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeDestinationsResponse.DescribeDestinationsResult"> <summary> Gets and sets the DescribeDestinationsResult property. Represents the output of a DescribeDestinations operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest"> <summary> Container for the parameters to the DescribeExportTasks operation. Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. <para> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeExportTasks</code> request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest.StatusCode"> <summary> Gets and sets the property StatusCode. <para> All export tasks that matches the specified status code will be returned. This can return zero or more export tasks. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksRequest.TaskId"> <summary> Gets and sets the property TaskId. <para> Export task that matches the specified task Id will be returned. This can result in zero or one export task. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse"> <summary> Configuration for accessing Amazon DescribeExportTasks service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeExportTasksResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksResult.ExportTasks"> <summary> Gets and sets the property ExportTasks. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeExportTasksResponse.DescribeExportTasksResult"> <summary> Gets and sets the DescribeExportTasksResult property. Represents the output of a DescribeExportTasks operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest"> <summary> Container for the parameters to the DescribeLogGroups operation. Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. <para> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest.LogGroupNamePrefix"> <summary> Gets and sets the property LogGroupNamePrefix. <para> Will only return log groups that match the provided logGroupNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeLogGroups</code> request. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse"> <summary> Configuration for accessing Amazon DescribeLogGroups service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogGroupsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsResult.LogGroups"> <summary> Gets and sets the property LogGroups. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogGroupsResponse.DescribeLogGroupsResult"> <summary> Gets and sets the DescribeLogGroupsResult property. Represents the output of a DescribeLogGroups operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest"> <summary> Container for the parameters to the DescribeLogStreams operation. Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. <para> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class="code">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.#ctor(System.String)"> <summary> Instantiates DescribeLogStreamsRequest with the parameterized properties </summary> <param name="logGroupName">The log group name for which log streams are to be listed.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.Descending"> <summary> Gets and sets the property Descending. <para> If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The log group name for which log streams are to be listed. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.LogStreamNamePrefix"> <summary> Gets and sets the property LogStreamNamePrefix. <para> Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeLogStreams</code> request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsRequest.OrderBy"> <summary> Gets and sets the property OrderBy. <para> Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse"> <summary> Configuration for accessing Amazon DescribeLogStreams service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeLogStreamsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsResult.LogStreams"> <summary> Gets and sets the property LogStreams. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeLogStreamsResponse.DescribeLogStreamsResult"> <summary> Gets and sets the DescribeLogStreamsResult property. Represents the output of a DescribeLogStreams operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest"> <summary> Container for the parameters to the DescribeMetricFilters operation. Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.#ctor(System.String)"> <summary> Instantiates DescribeMetricFiltersRequest with the parameterized properties </summary> <param name="logGroupName">The log group name for which metric filters are to be listed.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.FilterNamePrefix"> <summary> Gets and sets the property FilterNamePrefix. <para> Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The log group name for which metric filters are to be listed. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class="code">DescribeMetricFilters</code> request. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse"> <summary> Configuration for accessing Amazon DescribeMetricFilters service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResult.MetricFilters"> <summary> Gets and sets the property MetricFilters. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeMetricFiltersResponse.DescribeMetricFiltersResult"> <summary> Gets and sets the DescribeMetricFiltersResult property. Represents the output of a DescribeMetricFilters operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest"> <summary> Container for the parameters to the DescribeSubscriptionFilters operation. Returns all the subscription filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. <para> By default, this operation returns up to 50 subscription filters. If there are more subscription filters to list, the response would contain a <code class="code">nextToken</code> value in the response body. You can also limit the number of subscription filters returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest.FilterNamePrefix"> <summary> Gets and sets the property FilterNamePrefix. <para> Will only return subscription filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest.Limit"> <summary> Gets and sets the property Limit. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The log group name for which subscription filters are to be listed. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersRequest.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse"> <summary> Configuration for accessing Amazon DescribeSubscriptionFilters service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResult.NextToken"> <summary> Gets and sets the property NextToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResult.SubscriptionFilters"> <summary> Gets and sets the property SubscriptionFilters. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.DescribeSubscriptionFiltersResponse.DescribeSubscriptionFiltersResult"> <summary> Gets and sets the DescribeSubscriptionFiltersResult property. Represents the output of a DescribeSubscriptionFilters operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Destination"> <summary> A cross account destination that is the recipient of subscription log events. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.AccessPolicy"> <summary> Gets and sets the property AccessPolicy. <para> An IAM policy document that governs which AWS accounts can create subscription filters against this destination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.Arn"> <summary> Gets and sets the property Arn. <para> ARN of this destination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.CreationTime"> <summary> Gets and sets the property CreationTime. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.DestinationName"> <summary> Gets and sets the property DestinationName. <para> Name of the destination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.RoleArn"> <summary> Gets and sets the property RoleArn. <para> A role for impersonation for delivering log events to the target. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.Destination.TargetArn"> <summary> Gets and sets the property TargetArn. <para> ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream). </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.ExportTask"> <summary> Represents an export task. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.Destination"> <summary> Gets and sets the property Destination. <para> Name of Amazon S3 bucket to which the log data was exported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.DestinationPrefix"> <summary> Gets and sets the property DestinationPrefix. <para> Prefix that was used as the start of Amazon S3 key for every object exported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.ExecutionInfo"> <summary> Gets and sets the property ExecutionInfo. <para> Execution info about the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.From"> <summary> Gets and sets the property From. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group from which logs data was exported. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.Status"> <summary> Gets and sets the property Status. <para> Status of the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.TaskId"> <summary> Gets and sets the property TaskId. <para> Id of the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.TaskName"> <summary> Gets and sets the property TaskName. <para> The name of the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTask.To"> <summary> Gets and sets the property To. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.ExportTaskExecutionInfo"> <summary> Represents the status of an export task. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTaskExecutionInfo.CompletionTime"> <summary> Gets and sets the property CompletionTime. <para> A point in time when the export task got completed. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTaskExecutionInfo.CreationTime"> <summary> Gets and sets the property CreationTime. <para> A point in time when the export task got created. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.ExportTaskStatus"> <summary> Represents the status of an export task. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTaskStatus.Code"> <summary> Gets and sets the property Code. <para> Status code of the export task. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.ExportTaskStatus.Message"> <summary> Gets and sets the property Message. <para> Status message related to the <code class="code">code</code>. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.FilteredLogEvent"> <summary> Represents a matched event from a <code class="code">FilterLogEvents</code> request. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilteredLogEvent.EventId"> <summary> Gets and sets the property EventId. <para> A unique identifier for this event. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilteredLogEvent.IngestionTime"> <summary> Gets and sets the property IngestionTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilteredLogEvent.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream this event belongs to. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilteredLogEvent.Message"> <summary> Gets and sets the property Message. <para> The data contained in the log event. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilteredLogEvent.Timestamp"> <summary> Gets and sets the property Timestamp. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest"> <summary> Container for the parameters to the FilterLogEvents operation. Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. You can limit the streams searched to an explicit list of <code class="code">logStreamNames</code>. <para> By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a <code class="code">nextToken</code>, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of <code class="code">searchedLogStreams</code> that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The <code class="code">limit</code> parameter in the request. can be used to specify the maximum number of events to return in a page. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.FilterPattern"> <summary> Gets and sets the property FilterPattern. <para> A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.Interleaved"> <summary> Gets and sets the property Interleaved. <para> If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of events to return in a page of results. Default is 10,000 events. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to query. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.LogStreamNames"> <summary> Gets and sets the property LogStreamNames. <para> Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A pagination token obtained from a <code class="code">FilterLogEvents</code> response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.FilterLogEventsResponse"> <summary> Configuration for accessing Amazon FilterLogEvents service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.FilterLogEventsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsResult.Events"> <summary> Gets and sets the property Events. <para> A list of <code class="code">FilteredLogEvent</code> objects representing the matched events from the request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> A pagination token obtained from a <code class="code">FilterLogEvents</code> response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsResult.SearchedLogStreams"> <summary> Gets and sets the property SearchedLogStreams. <para> A list of <code class="code">SearchedLogStream</code> objects indicating which log streams have been searched in this request and whether each has been searched completely or still has more to be paginated. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.FilterLogEventsResponse.FilterLogEventsResult"> <summary> Gets and sets the FilterLogEventsResult property. Represents the output of a FilterLogEvents operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.GetLogEventsRequest"> <summary> Container for the parameters to the GetLogEvents operation. Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event <code class="code">timestamp</code>. <para> By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a <code class="code">nextForwardToken</code> and a <code class="code">nextBackwardToken</code> in the response body. You can use any of these tokens in subsequent <code class="code">GetLogEvents</code> requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the <code class="code">limit</code> parameter in the request. </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.#ctor(System.String,System.String)"> <summary> Instantiates GetLogEventsRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to query.</param> <param name="logStreamName">The name of the log stream to query.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.EndTime"> <summary> Gets and sets the property EndTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to query. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream to query. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A string token used for pagination that points to the next page of results. It must be a value obtained from the <code class="code">nextForwardToken</code> or <code class="code">nextBackwardToken</code> fields in the response of the previous <code class="code">GetLogEvents</code> request. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.StartFromHead"> <summary> Gets and sets the property StartFromHead. <para> If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first). </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsRequest.StartTime"> <summary> Gets and sets the property StartTime. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.GetLogEventsResponse"> <summary> Configuration for accessing Amazon GetLogEvents service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.GetLogEventsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsResult.Events"> <summary> Gets and sets the property Events. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsResult.NextBackwardToken"> <summary> Gets and sets the property NextBackwardToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsResult.NextForwardToken"> <summary> Gets and sets the property NextForwardToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.GetLogEventsResponse.GetLogEventsResult"> <summary> Gets and sets the GetLogEventsResult property. Represents the output of a GetLogEvents operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.InputLogEvent"> <summary> A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.InputLogEvent.Message"> <summary> Gets and sets the property Message. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.InputLogEvent.Timestamp"> <summary> Gets and sets the property Timestamp. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.InvalidOperationException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.InvalidOperationException.#ctor(System.String)"> <summary> Constructs a new InvalidOperationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.InvalidParameterException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.InvalidParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.InvalidSequenceTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidSequenceTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.LimitExceededException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.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.CloudWatchLogs.Model.LogGroup"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.Arn"> <summary> Gets and sets the property Arn. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.CreationTime"> <summary> Gets and sets the property CreationTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.LogGroupName"> <summary> Gets and sets the property LogGroupName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.MetricFilterCount"> <summary> Gets and sets the property MetricFilterCount. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.RetentionInDays"> <summary> Gets and sets the property RetentionInDays. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogGroup.StoredBytes"> <summary> Gets and sets the property StoredBytes. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.LogStream"> <summary> A log stream is sequence of log events from a single emitter of logs. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.Arn"> <summary> Gets and sets the property Arn. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.CreationTime"> <summary> Gets and sets the property CreationTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.FirstEventTimestamp"> <summary> Gets and sets the property FirstEventTimestamp. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.LastEventTimestamp"> <summary> Gets and sets the property LastEventTimestamp. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.LastIngestionTime"> <summary> Gets and sets the property LastIngestionTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.LogStreamName"> <summary> Gets and sets the property LogStreamName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.StoredBytes"> <summary> Gets and sets the property StoredBytes. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.LogStream.UploadSequenceToken"> <summary> Gets and sets the property UploadSequenceToken. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.MetricFilter"> <summary> Metric filters can be used to express how CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilter.CreationTime"> <summary> Gets and sets the property CreationTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilter.FilterName"> <summary> Gets and sets the property FilterName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilter.FilterPattern"> <summary> Gets and sets the property FilterPattern. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilter.MetricTransformations"> <summary> Gets and sets the property MetricTransformations. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.MetricFilterMatchRecord"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilterMatchRecord.EventMessage"> <summary> Gets and sets the property EventMessage. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilterMatchRecord.EventNumber"> <summary> Gets and sets the property EventNumber. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricFilterMatchRecord.ExtractedValues"> <summary> Gets and sets the property ExtractedValues. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.MetricTransformation"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricTransformation.MetricName"> <summary> Gets and sets the property MetricName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricTransformation.MetricNamespace"> <summary> Gets and sets the property MetricNamespace. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.MetricTransformation.MetricValue"> <summary> Gets and sets the property MetricValue. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.OperationAbortedException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.OperationAbortedException.#ctor(System.String)"> <summary> Constructs a new OperationAbortedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.OutputLogEvent"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.OutputLogEvent.IngestionTime"> <summary> Gets and sets the property IngestionTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.OutputLogEvent.Message"> <summary> Gets and sets the property Message. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.OutputLogEvent.Timestamp"> <summary> Gets and sets the property Timestamp. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest"> <summary> Container for the parameters to the PutDestinationPolicy operation. Creates or updates an access policy associated with an existing <code>Destination</code>. An access policy is an <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest.AccessPolicy"> <summary> Gets and sets the property AccessPolicy. <para> An IAM policy document that authorizes cross-account users to deliver their log events to associated destination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationPolicyRequest.DestinationName"> <summary> Gets and sets the property DestinationName. <para> A name for an existing destination. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutDestinationRequest"> <summary> Container for the parameters to the PutDestination operation. Creates or updates a <code>Destination</code>. A destination encapsulates a physical resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream of log events of a different account, ingested through <code class="code">PutLogEvents</code> requests. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination. <para> A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user will not be able to call <code>PutSubscriptionFilter</code> against this destination. To enable that, the destination owner must call <code>PutDestinationPolicy</code> after PutDestination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationRequest.DestinationName"> <summary> Gets and sets the property DestinationName. <para> A name for the destination. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationRequest.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The ARN of an IAM role that grants CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationRequest.TargetArn"> <summary> Gets and sets the property TargetArn. <para> The ARN of an Amazon Kinesis stream to deliver matching log events to. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutDestinationResponse"> <summary> Configuration for accessing Amazon PutDestination service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutDestinationResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationResult.Destination"> <summary> Gets and sets the property Destination. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutDestinationResponse.PutDestinationResult"> <summary> Gets and sets the PutDestinationResult property. Represents the output of a PutDestination operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutLogEventsRequest"> <summary> Container for the parameters to the PutLogEvents operation. Uploads a batch of log events to the specified log stream. <para> Every PutLogEvents request must include the <code class="code">sequenceToken</code> obtained from the response of the previous request. An upload in a newly created log stream does not require a <code class="code">sequenceToken</code>. </para> <para> The batch of events must satisfy the following constraints: <ul> <li>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</li> <li>None of the log events in the batch can be more than 2 hours in the future.</li> <li>None of the log events in the batch can be older than 14 days or the retention period of the log group.</li> <li>The log events in the batch must be in chronological ordered by their <code class="code">timestamp</code>.</li> <li>The maximum number of log events in a batch is 10,000.</li> <li>A batch of log events in a single PutLogEvents request cannot span more than 24 hours. Otherwise, the PutLogEvents operation will fail.</li> </ul> </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.#ctor(System.String,System.String,System.Collections.Generic.List{Amazon.CloudWatchLogs.Model.InputLogEvent})"> <summary> Instantiates PutLogEventsRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to put log events to.</param> <param name="logStreamName">The name of the log stream to put log events to.</param> <param name="logEvents">Sets the PutLogEventsRequest LogEvents property</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.LogEvents"> <summary> Gets and sets the property LogEvents. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to put log events to. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream to put log events to. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsRequest.SequenceToken"> <summary> Gets and sets the property SequenceToken. <para> A string token that must be obtained from the response of the previous <code class="code">PutLogEvents</code> request. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutLogEventsResponse"> <summary> Configuration for accessing Amazon PutLogEvents service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutLogEventsResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsResult.NextSequenceToken"> <summary> Gets and sets the property NextSequenceToken. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsResult.RejectedLogEventsInfo"> <summary> Gets and sets the property RejectedLogEventsInfo. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutLogEventsResponse.PutLogEventsResult"> <summary> Gets and sets the PutLogEventsResult property. Represents the output of a PutLogEvents operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest"> <summary> Container for the parameters to the PutMetricFilter operation. Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <code class="code">PutLogEvents</code> requests. <para> The maximum number of metric filters that can be associated with a log group is 100. </para> </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.#ctor(System.String,System.String,System.String,System.Collections.Generic.List{Amazon.CloudWatchLogs.Model.MetricTransformation})"> <summary> Instantiates PutMetricFilterRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to associate the metric filter with.</param> <param name="filterName">A name for the metric filter.</param> <param name="filterPattern">A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.</param> <param name="metricTransformations">A collection of information needed to define how metric data gets emitted.</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.FilterName"> <summary> Gets and sets the property FilterName. <para> A name for the metric filter. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.FilterPattern"> <summary> Gets and sets the property FilterPattern. <para> A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to associate the metric filter with. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutMetricFilterRequest.MetricTransformations"> <summary> Gets and sets the property MetricTransformations. <para> A collection of information needed to define how metric data gets emitted. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest"> <summary> Container for the parameters to the PutRetentionPolicy operation. Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest.#ctor(System.String,System.Int32)"> <summary> Instantiates PutRetentionPolicyRequest with the parameterized properties </summary> <param name="logGroupName">The name of the log group to associate the retention policy with.</param> <param name="retentionInDays">Sets the PutRetentionPolicyRequest RetentionInDays property</param> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to associate the retention policy with. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutRetentionPolicyRequest.RetentionInDays"> <summary> Gets and sets the property RetentionInDays. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest"> <summary> Container for the parameters to the PutSubscriptionFilter operation. Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <code class="code">PutLogEvents</code> requests and have them delivered to a specific destination. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> <para> Currently there can only be one subscription filter associated with a log group. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest.DestinationArn"> <summary> Gets and sets the property DestinationArn. <para> The ARN of the destination to deliver matching log events to. Currently, the supported destinations are: <ul> <li> An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> A logical destination (used via an ARN of <code>Destination</code>) belonging to a different account, for cross-account delivery. </li> <li> An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery. </li> <li> An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery. </li> </ul> </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest.FilterName"> <summary> Gets and sets the property FilterName. <para> A name for the subscription filter. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest.FilterPattern"> <summary> Gets and sets the property FilterPattern. <para> A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the log group to associate the subscription filter with. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.PutSubscriptionFilterRequest.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination (used via an ARN of <code>Destination</code>) for cross-account delivery. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.RejectedLogEventsInfo"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.RejectedLogEventsInfo.ExpiredLogEventEndIndex"> <summary> Gets and sets the property ExpiredLogEventEndIndex. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.RejectedLogEventsInfo.TooNewLogEventStartIndex"> <summary> Gets and sets the property TooNewLogEventStartIndex. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.RejectedLogEventsInfo.TooOldLogEventEndIndex"> <summary> Gets and sets the property TooOldLogEventEndIndex. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.Model.ResourceAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new ResourceAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.CloudWatchLogs.Model.ResourceNotFoundException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.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.CloudWatchLogs.Model.SearchedLogStream"> <summary> An object indicating the search status of a log stream in a <code class="code">FilterLogEvents</code> request. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SearchedLogStream.LogStreamName"> <summary> Gets and sets the property LogStreamName. <para> The name of the log stream. </para> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SearchedLogStream.SearchedCompletely"> <summary> Gets and sets the property SearchedCompletely. <para> Indicates whether all the events in this log stream were searched or more data exists to search by paginating further. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.ServiceUnavailableException"> <summary> CloudWatchLogs exception </summary> </member> <member name="M:Amazon.CloudWatchLogs.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.CloudWatchLogs.Model.SubscriptionFilter"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.CreationTime"> <summary> Gets and sets the property CreationTime. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.DestinationArn"> <summary> Gets and sets the property DestinationArn. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.FilterName"> <summary> Gets and sets the property FilterName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.FilterPattern"> <summary> Gets and sets the property FilterPattern. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.LogGroupName"> <summary> Gets and sets the property LogGroupName. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.SubscriptionFilter.RoleArn"> <summary> Gets and sets the property RoleArn. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.TestMetricFilterRequest"> <summary> Container for the parameters to the TestMetricFilter operation. Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.TestMetricFilterRequest.FilterPattern"> <summary> Gets and sets the property FilterPattern. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.TestMetricFilterRequest.LogEventMessages"> <summary> Gets and sets the property LogEventMessages. <para> A list of log event messages to test. </para> </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.TestMetricFilterResponse"> <summary> Configuration for accessing Amazon TestMetricFilter service </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.TestMetricFilterResult"> <summary> </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.TestMetricFilterResult.Matches"> <summary> Gets and sets the property Matches. </summary> </member> <member name="P:Amazon.CloudWatchLogs.Model.TestMetricFilterResponse.TestMetricFilterResult"> <summary> Gets and sets the TestMetricFilterResult property. Represents the output of a TestMetricFilter operation. </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CancelExportTaskRequestMarshaller"> <summary> CancelExportTask Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CancelExportTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CancelExportTask operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateExportTaskRequestMarshaller"> <summary> CreateExportTask Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateExportTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CreateExportTask operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateLogGroupRequestMarshaller"> <summary> CreateLogGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateLogGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLogGroup operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateLogStreamRequestMarshaller"> <summary> CreateLogStream Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.CreateLogStreamResponseUnmarshaller"> <summary> Response Unmarshaller for CreateLogStream operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteDestinationRequestMarshaller"> <summary> DeleteDestination Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteDestinationResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDestination operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteLogGroupRequestMarshaller"> <summary> DeleteLogGroup Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteLogGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLogGroup operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteLogStreamRequestMarshaller"> <summary> DeleteLogStream Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteLogStreamResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteLogStream operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteMetricFilterRequestMarshaller"> <summary> DeleteMetricFilter Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteMetricFilterResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteMetricFilter operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteRetentionPolicyRequestMarshaller"> <summary> DeleteRetentionPolicy Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteRetentionPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRetentionPolicy operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteSubscriptionFilterRequestMarshaller"> <summary> DeleteSubscriptionFilter Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DeleteSubscriptionFilterResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSubscriptionFilter operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeDestinationsRequestMarshaller"> <summary> DescribeDestinations Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeDestinationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDestinations operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeExportTasksRequestMarshaller"> <summary> DescribeExportTasks Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeExportTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeExportTasks operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeLogGroupsRequestMarshaller"> <summary> DescribeLogGroups Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeLogGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLogGroups operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeLogStreamsRequestMarshaller"> <summary> DescribeLogStreams Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeLogStreamsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLogStreams operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeMetricFiltersRequestMarshaller"> <summary> DescribeMetricFilters Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeMetricFiltersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeMetricFilters operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeSubscriptionFiltersRequestMarshaller"> <summary> DescribeSubscriptionFilters Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DescribeSubscriptionFiltersResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSubscriptionFilters operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.DestinationUnmarshaller"> <summary> Response Unmarshaller for Destination Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.ExportTaskExecutionInfoUnmarshaller"> <summary> Response Unmarshaller for ExportTaskExecutionInfo Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.ExportTaskStatusUnmarshaller"> <summary> Response Unmarshaller for ExportTaskStatus Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.ExportTaskUnmarshaller"> <summary> Response Unmarshaller for ExportTask Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.FilteredLogEventUnmarshaller"> <summary> Response Unmarshaller for FilteredLogEvent Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.FilterLogEventsRequestMarshaller"> <summary> FilterLogEvents Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.FilterLogEventsResponseUnmarshaller"> <summary> Response Unmarshaller for FilterLogEvents operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.GetLogEventsRequestMarshaller"> <summary> GetLogEvents Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.GetLogEventsResponseUnmarshaller"> <summary> Response Unmarshaller for GetLogEvents operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.InputLogEventMarshaller"> <summary> InputLogEvent Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.LogGroupUnmarshaller"> <summary> Response Unmarshaller for LogGroup Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.LogStreamUnmarshaller"> <summary> Response Unmarshaller for LogStream Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.MetricFilterMatchRecordUnmarshaller"> <summary> Response Unmarshaller for MetricFilterMatchRecord Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.MetricFilterUnmarshaller"> <summary> Response Unmarshaller for MetricFilter Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.MetricTransformationMarshaller"> <summary> MetricTransformation Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.MetricTransformationUnmarshaller"> <summary> Response Unmarshaller for MetricTransformation Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.OutputLogEventUnmarshaller"> <summary> Response Unmarshaller for OutputLogEvent Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutDestinationPolicyRequestMarshaller"> <summary> PutDestinationPolicy Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutDestinationPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for PutDestinationPolicy operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutDestinationRequestMarshaller"> <summary> PutDestination Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutDestinationResponseUnmarshaller"> <summary> Response Unmarshaller for PutDestination operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutLogEventsRequestMarshaller"> <summary> PutLogEvents Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutLogEventsResponseUnmarshaller"> <summary> Response Unmarshaller for PutLogEvents operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutMetricFilterRequestMarshaller"> <summary> PutMetricFilter Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutMetricFilterResponseUnmarshaller"> <summary> Response Unmarshaller for PutMetricFilter operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutRetentionPolicyRequestMarshaller"> <summary> PutRetentionPolicy Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutRetentionPolicyResponseUnmarshaller"> <summary> Response Unmarshaller for PutRetentionPolicy operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutSubscriptionFilterRequestMarshaller"> <summary> PutSubscriptionFilter Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.PutSubscriptionFilterResponseUnmarshaller"> <summary> Response Unmarshaller for PutSubscriptionFilter operation </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.RejectedLogEventsInfoUnmarshaller"> <summary> Response Unmarshaller for RejectedLogEventsInfo Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.SearchedLogStreamUnmarshaller"> <summary> Response Unmarshaller for SearchedLogStream Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.SubscriptionFilterUnmarshaller"> <summary> Response Unmarshaller for SubscriptionFilter Object </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.TestMetricFilterRequestMarshaller"> <summary> TestMetricFilter Request Marshaller </summary> </member> <member name="T:Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations.TestMetricFilterResponseUnmarshaller"> <summary> Response Unmarshaller for TestMetricFilter operation </summary> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineClient"> <summary> Implementation for accessing DataPipeline AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data. <para> AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management. </para> <para> AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service. </para> </summary> </member> <member name="T:Amazon.DataPipeline.IAmazonDataPipeline"> <summary> Interface for accessing DataPipeline AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data. <para> AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management. </para> <para> AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service. </para> </summary> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"> <summary> Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para> <para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline service method.</param> <returns>The response from the ActivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndActivatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ActivatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginActivatePipeline.</param> <returns>Returns a ActivatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.AddTags(System.String,System.Collections.Generic.List{Amazon.DataPipeline.Model.Tag})"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tags">The tags to add, as key/value pairs.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.AddTags(Amazon.DataPipeline.Model.AddTagsRequest)"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginAddTags(Amazon.DataPipeline.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.IAmazonDataPipeline.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginCreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndCreatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest)"> <summary> Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline service method.</param> <returns>The response from the DeactivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginDeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeactivatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.EndDeactivatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeactivatePipeline.</param> <returns>Returns a DeactivatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginDeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.IAmazonDataPipeline.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects service method.</param> <returns>The response from the DescribeObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginDescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndDescribeObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeObjects operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeObjects.</param> <returns>Returns a DescribeObjectsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines(System.Collections.Generic.List{System.String})"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines service method.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginDescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndDescribePipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePipelines operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePipelines.</param> <returns>Returns a DescribePipelinesResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression service method.</param> <returns>The response from the EvaluateExpression service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginEvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndEvaluateExpression(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EvaluateExpression operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEvaluateExpression.</param> <returns>Returns a EvaluateExpressionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition service method.</param> <returns>The response from the GetPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginGetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndGetPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPipelineDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineDefinition.</param> <returns>Returns a GetPipelineDefinitionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ListPipelines"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndListPipelines(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListPipelines operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForTask service method.</param> <returns>The response from the PollForTask service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginPollForTask(Amazon.DataPipeline.Model.PollForTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForTask operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndPollForTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PollForTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForTask.</param> <returns>Returns a PollForTaskResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para> <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition service method.</param> <returns>The response from the PutPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginPutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndPutPipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutPipelineDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPipelineDefinition.</param> <returns>Returns a PutPipelineDefinitionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects service method.</param> <returns>The response from the QueryObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginQueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndQueryObjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the QueryObjects operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQueryObjects.</param> <returns>Returns a QueryObjectsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.RemoveTags(System.String,System.Collections.Generic.List{System.String})"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tagKeys">The keys of the tags to remove.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.RemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest)"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginRemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.IAmazonDataPipeline.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress service method.</param> <returns>The response from the ReportTaskProgress service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndReportTaskProgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskProgress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskProgress.</param> <returns>Returns a ReportTaskProgressResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndReportTaskRunnerHeartbeat(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportTaskRunnerHeartbeat operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskRunnerHeartbeat.</param> <returns>Returns a ReportTaskRunnerHeartbeatResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus service method.</param> <returns>The response from the SetStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginSetStatus(Amazon.DataPipeline.Model.SetStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetStatus operation.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.EndSetStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStatus.</param> <returns>Returns a SetStatusResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus service method.</param> <returns>The response from the SetTaskStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginSetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndSetTaskStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetTaskStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTaskStatus.</param> <returns>Returns a SetTaskStatusResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition service method.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.IAmazonDataPipeline.BeginValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDataPipeline.EndValidatePipelineDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ValidatePipelineDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidatePipelineDefinition.</param> <returns>Returns a ValidatePipelineDefinitionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Credentials and an AmazonDataPipelineClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.#ctor(System.String,System.String,System.String,Amazon.DataPipeline.AmazonDataPipelineConfig)"> <summary> Constructs AmazonDataPipelineClient with AWS Access Key ID, AWS Secret Key and an AmazonDataPipelineClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDataPipelineClient Configuration Object</param> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest)"> <summary> Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para> <para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline service method.</param> <returns>The response from the ActivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginActivatePipeline(Amazon.DataPipeline.Model.ActivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ActivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the ActivatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginActivatePipeline.</param> <returns>Returns a ActivatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.AddTags(System.String,System.Collections.Generic.List{Amazon.DataPipeline.Model.Tag})"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tags">The tags to add, as key/value pairs.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.AddTags(Amazon.DataPipeline.Model.AddTagsRequest)"> <summary> Adds or modifies tags for the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the AddTags service method.</param> <returns>The response from the AddTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginAddTags(Amazon.DataPipeline.Model.AddTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AddTags operation. </summary> <param name="request">Container for the necessary parameters to execute the AddTags operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.AmazonDataPipelineClient.EndAddTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AddTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAddTags.</param> <returns>Returns a AddTagsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.CreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest)"> <summary> Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline service method.</param> <returns>The response from the CreatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginCreatePipeline(Amazon.DataPipeline.Model.CreatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePipeline.</param> <returns>Returns a CreatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest)"> <summary> Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline service method.</param> <returns>The response from the DeactivatePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDeactivatePipeline(Amazon.DataPipeline.Model.DeactivatePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeactivatePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeactivatePipeline operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndDeactivatePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeactivatePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeactivatePipeline.</param> <returns>Returns a DeactivatePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest)"> <summary> Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline service method.</param> <returns>The response from the DeletePipeline service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDeletePipeline(Amazon.DataPipeline.Model.DeletePipelineRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePipeline operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePipeline operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.AmazonDataPipelineClient.EndDeletePipeline(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePipeline operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePipeline.</param> <returns>Returns a DeletePipelineResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest)"> <summary> Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects service method.</param> <returns>The response from the DescribeObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDescribeObjects(Amazon.DataPipeline.Model.DescribeObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeObjects operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeObjects.</param> <returns>Returns a DescribeObjectsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelines(System.Collections.Generic.List{System.String})"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="pipelineIds">The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.DescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest)"> <summary> Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines service method.</param> <returns>The response from the DescribePipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginDescribePipelines(Amazon.DataPipeline.Model.DescribePipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePipelines operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePipelines.</param> <returns>Returns a DescribePipelinesResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest)"> <summary> Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression service method.</param> <returns>The response from the EvaluateExpression service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginEvaluateExpression(Amazon.DataPipeline.Model.EvaluateExpressionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EvaluateExpression operation. </summary> <param name="request">Container for the necessary parameters to execute the EvaluateExpression operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEvaluateExpression.</param> <returns>Returns a EvaluateExpressionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.GetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest)"> <summary> Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition service method.</param> <returns>The response from the GetPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginGetPipelineDefinition(Amazon.DataPipeline.Model.GetPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPipelineDefinition.</param> <returns>Returns a GetPipelineDefinitionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest)"> <summary> Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines service method.</param> <returns>The response from the ListPipelines service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginListPipelines(Amazon.DataPipeline.Model.ListPipelinesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListPipelines operation. </summary> <param name="request">Container for the necessary parameters to execute the ListPipelines operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListPipelines.</param> <returns>Returns a ListPipelinesResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PollForTask(Amazon.DataPipeline.Model.PollForTaskRequest)"> <summary> Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the PollForTask service method.</param> <returns>The response from the PollForTask service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginPollForTask(Amazon.DataPipeline.Model.PollForTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PollForTask operation. </summary> <param name="request">Container for the necessary parameters to execute the PollForTask operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPollForTask.</param> <returns>Returns a PollForTaskResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.PutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest)"> <summary> Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para> <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition service method.</param> <returns>The response from the PutPipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginPutPipelineDefinition(Amazon.DataPipeline.Model.PutPipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutPipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the PutPipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutPipelineDefinition.</param> <returns>Returns a PutPipelineDefinitionResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.QueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest)"> <summary> Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects service method.</param> <returns>The response from the QueryObjects service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginQueryObjects(Amazon.DataPipeline.Model.QueryObjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the QueryObjects operation. </summary> <param name="request">Container for the necessary parameters to execute the QueryObjects operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQueryObjects.</param> <returns>Returns a QueryObjectsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.RemoveTags(System.String,System.Collections.Generic.List{System.String})"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="pipelineId">The ID of the pipeline.</param> <param name="tagKeys">The keys of the tags to remove.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.RemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest)"> <summary> Removes existing tags from the specified pipeline. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags service method.</param> <returns>The response from the RemoveTags service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginRemoveTags(Amazon.DataPipeline.Model.RemoveTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RemoveTags operation. </summary> <param name="request">Container for the necessary parameters to execute the RemoveTags operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DataPipeline.AmazonDataPipelineClient.EndRemoveTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RemoveTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRemoveTags.</param> <returns>Returns a RemoveTagsResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest)"> <summary> Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress service method.</param> <returns>The response from the ReportTaskProgress service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginReportTaskProgress(Amazon.DataPipeline.Model.ReportTaskProgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskProgress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskProgress operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskProgress.</param> <returns>Returns a ReportTaskProgressResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest)"> <summary> Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method.</param> <returns>The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginReportTaskRunnerHeartbeat(Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportTaskRunnerHeartbeat operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportTaskRunnerHeartbeat.</param> <returns>Returns a ReportTaskRunnerHeartbeatResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetStatus(Amazon.DataPipeline.Model.SetStatusRequest)"> <summary> Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus service method.</param> <returns>The response from the SetStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginSetStatus(Amazon.DataPipeline.Model.SetStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetStatus operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSetStatus operation.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.EndSetStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the SetStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetStatus.</param> <returns>Returns a SetStatusResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.SetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest)"> <summary> Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus service method.</param> <returns>The response from the SetTaskStatus service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> <exception cref="T:Amazon.DataPipeline.Model.TaskNotFoundException"> The specified task was not found. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginSetTaskStatus(Amazon.DataPipeline.Model.SetTaskStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the SetTaskStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the SetTaskStatus operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginSetTaskStatus.</param> <returns>Returns a SetTaskStatusResult from DataPipeline.</returns> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.ValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest)"> <summary> Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition service method.</param> <returns>The response from the ValidatePipelineDefinition service method, as returned by DataPipeline.</returns> <exception cref="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> An internal service error occurred. </exception> <exception cref="T:Amazon.DataPipeline.Model.InvalidRequestException"> The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineDeletedException"> The specified pipeline has been deleted. </exception> <exception cref="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> The specified pipeline was not found. Verify that you used the correct user and account identifiers. </exception> </member> <member name="M:Amazon.DataPipeline.AmazonDataPipelineClient.BeginValidatePipelineDefinition(Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ValidatePipelineDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the ValidatePipelineDefinition operation on AmazonDataPipelineClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginValidatePipelineDefinition.</param> <returns>Returns a ValidatePipelineDefinitionResult from DataPipeline.</returns> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineConfig"> <summary> Configuration for accessing Amazon DataPipeline 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.OperatorType"> <summary> Constants used for properties of type OperatorType. </summary> </member> <member name="F:Amazon.DataPipeline.OperatorType.BETWEEN"> <summary> Constant BETWEEN for OperatorType </summary> </member> <member name="F:Amazon.DataPipeline.OperatorType.EQ"> <summary> Constant EQ for OperatorType </summary> </member> <member name="F:Amazon.DataPipeline.OperatorType.GE"> <summary> Constant GE for OperatorType </summary> </member> <member name="F:Amazon.DataPipeline.OperatorType.LE"> <summary> Constant LE for OperatorType </summary> </member> <member name="F:Amazon.DataPipeline.OperatorType.REF_EQ"> <summary> Constant REF_EQ for OperatorType </summary> </member> <member name="M:Amazon.DataPipeline.OperatorType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DataPipeline.OperatorType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DataPipeline.TaskStatus"> <summary> Constants used for properties of type TaskStatus. </summary> </member> <member name="F:Amazon.DataPipeline.TaskStatus.FAILED"> <summary> Constant FAILED for TaskStatus </summary> </member> <member name="F:Amazon.DataPipeline.TaskStatus.FALSE"> <summary> Constant FALSE for TaskStatus </summary> </member> <member name="F:Amazon.DataPipeline.TaskStatus.FINISHED"> <summary> Constant FINISHED for TaskStatus </summary> </member> <member name="M:Amazon.DataPipeline.TaskStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DataPipeline.TaskStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineRequest"> <summary> Container for the parameters to the ActivatePipeline operation. Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. <para> If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call <a>DeactivatePipeline</a>. </para> <para> To activate a finished pipeline, modify the end date for the pipeline and then activate it. </para> </summary> </member> <member name="T:Amazon.DataPipeline.AmazonDataPipelineRequest"> <summary> Base class for DataPipeline operation requests. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineRequest.ParameterValues"> <summary> Gets and sets the property ParameterValues. <para> A list of parameter values to pass to the pipeline at activation. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineRequest.StartTimestamp"> <summary> Gets and sets the property StartTimestamp. <para> The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineResponse"> <summary> Configuration for accessing Amazon ActivatePipeline service </summary> </member> <member name="T:Amazon.DataPipeline.Model.ActivatePipelineResult"> <summary> Contains the output of ActivatePipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ActivatePipelineResponse.ActivatePipelineResult"> <summary> Gets and sets the ActivatePipelineResult property. Represents the output of a ActivatePipeline operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.AddTagsRequest"> <summary> Container for the parameters to the AddTags operation. Adds or modifies tags for the specified pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.AddTagsRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.AddTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> The tags to add, as key/value pairs. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.AddTagsResponse"> <summary> Configuration for accessing Amazon AddTags service </summary> </member> <member name="T:Amazon.DataPipeline.Model.AddTagsResult"> <summary> Contains the output of AddTags. </summary> </member> <member name="P:Amazon.DataPipeline.Model.AddTagsResponse.AddTagsResult"> <summary> Gets and sets the AddTagsResult property. Represents the output of a AddTags operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineRequest"> <summary> Container for the parameters to the CreatePipeline operation. Creates a new, empty pipeline. Use <a>PutPipelineDefinition</a> to populate the pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.Description"> <summary> Gets and sets the property Description. <para> The description for the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.Name"> <summary> Gets and sets the property Name. <para> The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineRequest.UniqueId"> <summary> Gets and sets the property UniqueId. <para> A unique identifier. 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 <code>CreatePipeline</code>. For example, if the first call to <code>CreatePipeline</code> does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <code>CreatePipeline</code>. <code>CreatePipeline</code> ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not 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> </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineResponse"> <summary> Configuration for accessing Amazon CreatePipeline service </summary> </member> <member name="T:Amazon.DataPipeline.Model.CreatePipelineResult"> <summary> Contains the output of CreatePipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineResult.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID that AWS Data Pipeline assigns the newly created pipeline. For example, <code>df-06372391ZG65EXAMPLE</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.CreatePipelineResponse.CreatePipelineResult"> <summary> Gets and sets the CreatePipelineResult property. Represents the output of a CreatePipeline operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeactivatePipelineRequest"> <summary> Container for the parameters to the DeactivatePipeline operation. Deactivates the specified running pipeline. The pipeline is set to the <code>DEACTIVATING</code> state until the deactivation process completes. <para> To resume a deactivated pipeline, use <a>ActivatePipeline</a>. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DeactivatePipelineRequest.CancelActive"> <summary> Gets and sets the property CancelActive. <para> Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DeactivatePipelineRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeactivatePipelineResponse"> <summary> Configuration for accessing Amazon DeactivatePipeline service </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeactivatePipelineResult"> <summary> Contains the output of DeactivatePipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DeactivatePipelineResponse.DeactivatePipelineResult"> <summary> Gets and sets the DeactivatePipelineResult property. Represents the output of a DeactivatePipeline operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DeletePipelineRequest"> <summary> Container for the parameters to the DeletePipeline operation. Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. <para> Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to <code>PAUSE</code> on individual components. Components that are paused by <a>SetStatus</a> can be resumed. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DeletePipelineRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsRequest"> <summary> Container for the parameters to the DescribeObjects operation. Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.EvaluateExpressions"> <summary> Gets and sets the property EvaluateExpressions. <para> Indicates whether any expressions in the object should be evaluated when the object descriptions are returned. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>DescribeObjects</code> with the marker value from the previous call to retrieve the next set of results. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.ObjectIds"> <summary> Gets and sets the property ObjectIds. <para> The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to <code>DescribeObjects</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline that contains the object definitions. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsResponse"> <summary> Configuration for accessing Amazon DescribeObjects service </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribeObjectsResult"> <summary> Contains the output of DescribeObjects. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.HasMoreResults"> <summary> Gets and sets the property HasMoreResults. <para> Indicates whether there are more results to return. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the next page of results. To view the next page of results, call <code>DescribeObjects</code> again with this marker value. If the value is null, there are no more results. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResult.PipelineObjects"> <summary> Gets and sets the property PipelineObjects. <para> An array of object definitions. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribeObjectsResponse.DescribeObjectsResult"> <summary> Gets and sets the DescribeObjectsResult property. Represents the output of a DescribeObjects operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesRequest"> <summary> Container for the parameters to the DescribePipelines operation. Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. <para> To retrieve the full pipeline definition instead of metadata about the pipeline, call <a>GetPipelineDefinition</a>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesRequest.PipelineIds"> <summary> Gets and sets the property PipelineIds. <para> The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call <a>ListPipelines</a>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesResponse"> <summary> Configuration for accessing Amazon DescribePipelines service </summary> </member> <member name="T:Amazon.DataPipeline.Model.DescribePipelinesResult"> <summary> Contains the output of DescribePipelines. </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesResult.PipelineDescriptionList"> <summary> Gets and sets the property PipelineDescriptionList. <para> An array of descriptions for the specified pipelines. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.DescribePipelinesResponse.DescribePipelinesResult"> <summary> Gets and sets the DescribePipelinesResult property. Represents the output of a DescribePipelines operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionRequest"> <summary> Container for the parameters to the EvaluateExpression operation. Task runners call <code>EvaluateExpression</code> to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.Expression"> <summary> Gets and sets the property Expression. <para> The expression to evaluate. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.ObjectId"> <summary> Gets and sets the property ObjectId. <para> The ID of the object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionResponse"> <summary> Configuration for accessing Amazon EvaluateExpression service </summary> </member> <member name="T:Amazon.DataPipeline.Model.EvaluateExpressionResult"> <summary> Contains the output of EvaluateExpression. </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionResult.EvaluatedExpression"> <summary> Gets and sets the property EvaluatedExpression. <para> The evaluated expression. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.EvaluateExpressionResponse.EvaluateExpressionResult"> <summary> Gets and sets the EvaluateExpressionResult property. Represents the output of a EvaluateExpression operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Field"> <summary> A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both. </summary> </member> <member name="P:Amazon.DataPipeline.Model.Field.Key"> <summary> Gets and sets the property Key. <para> The field identifier. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Field.RefValue"> <summary> Gets and sets the property RefValue. <para> The field value, expressed as the identifier of another object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Field.StringValue"> <summary> Gets and sets the property StringValue. <para> The field value, expressed as a String. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest"> <summary> Container for the parameters to the GetPipelineDefinition operation. Gets the definition of the specified pipeline. You can call <code>GetPipelineDefinition</code> to retrieve the pipeline definition that you provided using <a>PutPipelineDefinition</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionRequest.Version"> <summary> Gets and sets the property Version. <para> The version of the pipeline definition to retrieve. Set this parameter to <code>latest</code> (default) to use the last definition saved to the pipeline or <code>active</code> to use the last definition that was activated. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionResponse"> <summary> Configuration for accessing Amazon GetPipelineDefinition service </summary> </member> <member name="T:Amazon.DataPipeline.Model.GetPipelineDefinitionResult"> <summary> Contains the output of GetPipelineDefinition. </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.ParameterObjects"> <summary> Gets and sets the property ParameterObjects. <para> The parameter objects used in the pipeline definition. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.ParameterValues"> <summary> Gets and sets the property ParameterValues. <para> The parameter values used in the pipeline definition. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResult.PipelineObjects"> <summary> Gets and sets the property PipelineObjects. <para> The objects defined in the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.GetPipelineDefinitionResponse.GetPipelineDefinitionResult"> <summary> Gets and sets the GetPipelineDefinitionResult property. Represents the output of a GetPipelineDefinition operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.InstanceIdentity"> <summary> <para> Identity information for the 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, 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> 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.InstanceIdentity.Document"> <summary> Gets and sets the property Document. <para> A description of an 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.InstanceIdentity.Signature"> <summary> Gets and sets the property Signature. <para> A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.InternalServiceErrorException"> <summary> DataPipeline 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.InvalidRequestException"> <summary> DataPipeline 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. Lists the pipeline identifiers for all active pipelines that you have permission to access. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesRequest.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>ListPipelines</code> with the marker value from the previous call to retrieve the next set of results. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ListPipelinesResponse"> <summary> Configuration for accessing Amazon ListPipelines service </summary> </member> <member name="T:Amazon.DataPipeline.Model.ListPipelinesResult"> <summary> Contains the output of ListPipelines. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.HasMoreResults"> <summary> Gets and sets the property HasMoreResults. <para> Indicates whether there are more results that can be obtained by a subsequent call. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the next page of results. To view the next page of results, call <code>ListPipelinesOutput</code> again with this marker value. If the value is null, there are no more results. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResult.PipelineIdList"> <summary> Gets and sets the property PipelineIdList. <para> The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ListPipelinesResponse.ListPipelinesResult"> <summary> Gets and sets the ListPipelinesResult property. Represents the output of a ListPipelines operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Operator"> <summary> Contains a logical operation for comparing the value of a field with a specified value. </summary> </member> <member name="P:Amazon.DataPipeline.Model.Operator.Type"> <summary> Gets and sets the property Type. <para> The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) 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. </para> <para> The comparison operators EQ and REF_EQ act on the following fields: </para> <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> <para> The comparison operators <code>GE</code>, <code>LE</code>, and <code>BETWEEN</code> act on the following fields: </para> <ul> <li>@scheduledStartTime</li> <li>@scheduledEndTime</li> <li>@actualStartTime</li> <li>@actualEndTime</li> </ul> <para> 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Operator.Values"> <summary> Gets and sets the property Values. <para> The value that the actual field value will be compared with. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ParameterAttribute"> <summary> The attributes allowed or specified with a parameter object. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterAttribute.Key"> <summary> Gets and sets the property Key. <para> The field identifier. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterAttribute.StringValue"> <summary> Gets and sets the property StringValue. <para> The field value, expressed as a String. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ParameterObject"> <summary> Contains information about a parameter object. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterObject.Attributes"> <summary> Gets and sets the property Attributes. <para> The attributes of the parameter object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterObject.Id"> <summary> Gets and sets the property Id. <para> The ID of the parameter object. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ParameterValue"> <summary> A value or list of parameter values. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterValue.Id"> <summary> Gets and sets the property Id. <para> The ID of the parameter value. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ParameterValue.StringValue"> <summary> Gets and sets the property StringValue. <para> The field value, expressed as a String. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineDeletedException"> <summary> DataPipeline 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> Contains pipeline metadata. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Description"> <summary> Gets and sets the property Description. <para> Description of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Fields"> <summary> Gets and sets the property Fields. <para> A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineDescription.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineIdName"> <summary> Contains the name and identifier of a pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineIdName.Id"> <summary> Gets and sets the property Id. <para> The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineIdName.Name"> <summary> Gets and sets the property Name. <para> The name of the pipeline. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PipelineNotFoundException"> <summary> DataPipeline 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> 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. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Fields"> <summary> Gets and sets the property Fields. <para> Key-value pairs that define the properties of the object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Id"> <summary> Gets and sets the property Id. <para> The ID of the object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PipelineObject.Name"> <summary> Gets and sets the property Name. <para> The name of the object. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskRequest"> <summary> Container for the parameters to the PollForTask operation. Task runners call <code>PollForTask</code> to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the <code>workerGroup</code> parameter. The task returned can come from any of the pipelines that match the <code>workerGroup</code> value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. <para> If tasks are ready in the work queue, <code>PollForTask</code> returns a response immediately. If no tasks are available in the queue, <code>PollForTask</code> uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <code>PollForTask</code> again on the same <code>workerGroup</code> until it receives a response, and this can take up to 90 seconds. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.Hostname"> <summary> Gets and sets the property Hostname. <para> The public DNS name of the calling task runner. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.InstanceIdentity"> <summary> Gets and sets the property InstanceIdentity. <para> Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using <code>http://169.254.169.254/latest/meta-data/instance-id</code>. 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> 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskRequest.WorkerGroup"> <summary> Gets and sets the property WorkerGroup. <para> 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 <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskResponse"> <summary> Configuration for accessing Amazon PollForTask service </summary> </member> <member name="T:Amazon.DataPipeline.Model.PollForTaskResult"> <summary> Contains the output of PollForTask. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskResult.TaskObject"> <summary> Gets and sets the property TaskObject. <para> The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is <code>taskId</code>, which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <a>ReportTaskProgress</a> and <a>SetTaskStatus</a>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PollForTaskResponse.PollForTaskResult"> <summary> Gets and sets the PollForTaskResult property. Represents the output of a PollForTask operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest"> <summary> Container for the parameters to the PutPipelineDefinition operation. Adds tasks, schedules, and preconditions to the specified pipeline. You can use <code>PutPipelineDefinition</code> to populate a new pipeline. <para> <code>PutPipelineDefinition</code> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. </para> <ol> <li>An object is missing a name or identifier field.</li> <li>A string or reference field is empty.</li> <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li> <li>The pipeline is in a FINISHED state.</li> </ol> <para> Pipeline object definitions are passed to the <code>PutPipelineDefinition</code> action and returned by the <a>GetPipelineDefinition</a> action. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.ParameterObjects"> <summary> Gets and sets the property ParameterObjects. <para> The parameter objects used with the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.ParameterValues"> <summary> Gets and sets the property ParameterValues. <para> The parameter values used with the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionRequest.PipelineObjects"> <summary> Gets and sets the property PipelineObjects. <para> The objects that define the pipeline. These objects overwrite the existing pipeline definition. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionResponse"> <summary> Configuration for accessing Amazon PutPipelineDefinition service </summary> </member> <member name="T:Amazon.DataPipeline.Model.PutPipelineDefinitionResult"> <summary> Contains the output of PutPipelineDefinition. </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.Errored"> <summary> Gets and sets the property Errored. <para> Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call <code>PutPipelineDefinition</code> to commit the corrected pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.ValidationErrors"> <summary> Gets and sets the property ValidationErrors. <para> The validation errors that are associated with the objects defined in <code>pipelineObjects</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResult.ValidationWarnings"> <summary> Gets and sets the property ValidationWarnings. <para> The validation warnings that are associated with the objects defined in <code>pipelineObjects</code>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.PutPipelineDefinitionResponse.PutPipelineDefinitionResult"> <summary> Gets and sets the PutPipelineDefinitionResult property. Represents the output of a PutPipelineDefinition operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Query"> <summary> Defines the query to run against an object. </summary> </member> <member name="P:Amazon.DataPipeline.Model.Query.Selectors"> <summary> Gets and sets the property Selectors. <para> List of selectors that define the query. An object must satisfy all of the selectors to match the query. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsRequest"> <summary> Container for the parameters to the QueryObjects operation. Queries the specified pipeline for the names of objects that match the specified set of conditions. </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of object names that <code>QueryObjects</code> will return in a single call. The default value is 100. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call <code>QueryObjects</code> with the marker value from the previous call to retrieve the next set of results. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Query"> <summary> Gets and sets the property Query. <para> The query that defines the objects to be returned. The <code>Query</code> 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. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsRequest.Sphere"> <summary> Gets and sets the property Sphere. <para> Indicates whether the query applies to components or instances. The possible values are: <code>COMPONENT</code>, <code>INSTANCE</code>, and <code>ATTEMPT</code>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsResponse"> <summary> Configuration for accessing Amazon QueryObjects service </summary> </member> <member name="T:Amazon.DataPipeline.Model.QueryObjectsResult"> <summary> Contains the output of QueryObjects. </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.HasMoreResults"> <summary> Gets and sets the property HasMoreResults. <para> Indicates whether there are more results that can be obtained by a subsequent call. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.Ids"> <summary> Gets and sets the property Ids. <para> The identifiers that match the query selectors. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResult.Marker"> <summary> Gets and sets the property Marker. <para> The starting point for the next page of results. To view the next page of results, call <code>QueryObjects</code> again with this marker value. If the value is null, there are no more results. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.QueryObjectsResponse.QueryObjectsResult"> <summary> Gets and sets the QueryObjectsResult property. Represents the output of a QueryObjects operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.RemoveTagsRequest"> <summary> Container for the parameters to the RemoveTags operation. Removes existing tags from the specified pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.RemoveTagsRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.RemoveTagsRequest.TagKeys"> <summary> Gets and sets the property TagKeys. <para> The keys of the tags to remove. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.RemoveTagsResponse"> <summary> Configuration for accessing Amazon RemoveTags service </summary> </member> <member name="T:Amazon.DataPipeline.Model.RemoveTagsResult"> <summary> Contains the output of RemoveTags. </summary> </member> <member name="P:Amazon.DataPipeline.Model.RemoveTagsResponse.RemoveTagsResult"> <summary> Gets and sets the RemoveTagsResult property. Represents the output of a RemoveTags operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressRequest"> <summary> Container for the parameters to the ReportTaskProgress operation. Task runners call <code>ReportTaskProgress</code> when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline. <para> If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to <a>PollForTask</a>. Task runners should call <code>ReportTaskProgress</code> every 60 seconds. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressRequest.Fields"> <summary> Gets and sets the property Fields. <para> Key-value pairs that define the properties of the ReportTaskProgressInput object. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressRequest.TaskId"> <summary> Gets and sets the property TaskId. <para> The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressResponse"> <summary> Configuration for accessing Amazon ReportTaskProgress service </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskProgressResult"> <summary> Contains the output of ReportTaskProgress. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressResult.Canceled"> <summary> Gets and sets the property Canceled. <para> If true, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskProgressResponse.ReportTaskProgressResult"> <summary> Gets and sets the ReportTaskProgressResult property. Represents the output of a ReportTaskProgress operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest"> <summary> Container for the parameters to the ReportTaskRunnerHeartbeat operation. Task runners call <code>ReportTaskRunnerHeartbeat</code> every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.Hostname"> <summary> Gets and sets the property Hostname. <para> The public DNS name of the task runner. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.TaskrunnerId"> <summary> Gets and sets the property TaskrunnerId. <para> The ID 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatRequest.WorkerGroup"> <summary> Gets and sets the property WorkerGroup. <para> 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 <code>workerGroup</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResponse"> <summary> Configuration for accessing Amazon ReportTaskRunnerHeartbeat service </summary> </member> <member name="T:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResult"> <summary> Contains the output of ReportTaskRunnerHeartbeat. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResult.Terminate"> <summary> Gets and sets the property Terminate. <para> Indicates whether the calling task runner should terminate. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ReportTaskRunnerHeartbeatResponse.ReportTaskRunnerHeartbeatResult"> <summary> Gets and sets the ReportTaskRunnerHeartbeatResult property. Represents the output of a ReportTaskRunnerHeartbeat operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Selector"> <summary> A comparision that is used to determine whether a query should return this object. </summary> </member> <member name="P:Amazon.DataPipeline.Model.Selector.FieldName"> <summary> Gets and sets the property FieldName. <para> 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Selector.Operator"> <summary> Gets and sets the property Operator. </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetStatusRequest"> <summary> Container for the parameters to the SetStatus operation. Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on <code>FINISHED</code> pipelines and attempting to do so returns <code>InvalidRequestException</code>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.ObjectIds"> <summary> Gets and sets the property ObjectIds. <para> The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline that contains the objects. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetStatusRequest.Status"> <summary> Gets and sets the property Status. <para> The status to be set on all the objects specified in <code>objectIds</code>. For components, use <code>PAUSE</code> or <code>RESUME</code>. For instances, use <code>TRY_CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusRequest"> <summary> Container for the parameters to the SetTaskStatus operation. Task runners call <code>SetTaskStatus</code> to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call <code>SetTaskStatus</code> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorId"> <summary> Gets and sets the property ErrorId. <para> If an error occurred during the task, this value specifies the error code. 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorMessage"> <summary> Gets and sets the property ErrorMessage. <para> 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. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.ErrorStackTrace"> <summary> Gets and sets the property ErrorStackTrace. <para> 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> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.TaskId"> <summary> Gets and sets the property TaskId. <para> The ID of the task assigned to the task runner. This value is provided in the response for <a>PollForTask</a>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusRequest.TaskStatus"> <summary> Gets and sets the property TaskStatus. <para> If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code>, the task ended unsuccessfully. Preconditions use false. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusResponse"> <summary> Configuration for accessing Amazon SetTaskStatus service </summary> </member> <member name="T:Amazon.DataPipeline.Model.SetTaskStatusResult"> <summary> Contains the output of SetTaskStatus. </summary> </member> <member name="P:Amazon.DataPipeline.Model.SetTaskStatusResponse.SetTaskStatusResult"> <summary> Gets and sets the SetTaskStatusResult property. Represents the output of a SetTaskStatus operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.Tag"> <summary> Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>. </summary> </member> <member name="P:Amazon.DataPipeline.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The key name of a tag defined by a user. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The optional value portion of a tag defined by a user. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.TaskNotFoundException"> <summary> DataPipeline 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> Contains information about a pipeline task that is assigned to a task runner. </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.AttemptId"> <summary> Gets and sets the property AttemptId. <para> The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.Objects"> <summary> Gets and sets the property Objects. <para> Connection information for the location where the task runner will publish the output of the task. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline that provided the task. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.TaskObject.TaskId"> <summary> Gets and sets the property TaskId. <para> An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest"> <summary> Container for the parameters to the ValidatePipelineDefinition operation. Validates the specified pipeline definition to ensure that it is well formed and can be run without error. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.ParameterObjects"> <summary> Gets and sets the property ParameterObjects. <para> The parameter objects used with the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.ParameterValues"> <summary> Gets and sets the property ParameterValues. <para> The parameter values used with the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.PipelineId"> <summary> Gets and sets the property PipelineId. <para> The ID of the pipeline. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionRequest.PipelineObjects"> <summary> Gets and sets the property PipelineObjects. <para> The objects that define the pipeline changes to validate against the pipeline. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResponse"> <summary> Configuration for accessing Amazon ValidatePipelineDefinition service </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult"> <summary> Contains the output of ValidatePipelineDefinition. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.Errored"> <summary> Gets and sets the property Errored. <para> Indicates whether there were validation errors. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.ValidationErrors"> <summary> Gets and sets the property ValidationErrors. <para> Any validation errors that were found. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResult.ValidationWarnings"> <summary> Gets and sets the property ValidationWarnings. <para> Any validation warnings that were found. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidatePipelineDefinitionResponse.ValidatePipelineDefinitionResult"> <summary> Gets and sets the ValidatePipelineDefinitionResult property. Represents the output of a ValidatePipelineDefinition operation. </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidationError"> <summary> Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationError.Errors"> <summary> Gets and sets the property Errors. <para> A description of the validation error. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationError.Id"> <summary> Gets and sets the property Id. <para> The identifier of the object that contains the validation error. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.ValidationWarning"> <summary> Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline. </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationWarning.Id"> <summary> Gets and sets the property Id. <para> The identifier of the object that contains the validation warning. </para> </summary> </member> <member name="P:Amazon.DataPipeline.Model.ValidationWarning.Warnings"> <summary> Gets and sets the property Warnings. <para> A description of the validation warning. </para> </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ActivatePipelineRequestMarshaller"> <summary> ActivatePipeline 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.AddTagsRequestMarshaller"> <summary> AddTags Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.AddTagsResponseUnmarshaller"> <summary> Response Unmarshaller for AddTags operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.CreatePipelineRequestMarshaller"> <summary> CreatePipeline 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.DeactivatePipelineRequestMarshaller"> <summary> DeactivatePipeline Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DeactivatePipelineResponseUnmarshaller"> <summary> Response Unmarshaller for DeactivatePipeline operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.DeletePipelineRequestMarshaller"> <summary> DeletePipeline 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> DescribeObjects 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.DescribePipelinesRequestMarshaller"> <summary> DescribePipelines 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.EvaluateExpressionRequestMarshaller"> <summary> EvaluateExpression 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.FieldMarshaller"> <summary> Field Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.FieldUnmarshaller"> <summary> Response Unmarshaller for Field Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.GetPipelineDefinitionRequestMarshaller"> <summary> GetPipelineDefinition 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.InstanceIdentityMarshaller"> <summary> InstanceIdentity Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ListPipelinesRequestMarshaller"> <summary> ListPipelines 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.OperatorMarshaller"> <summary> Operator Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterAttributeMarshaller"> <summary> ParameterAttribute Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterAttributeUnmarshaller"> <summary> Response Unmarshaller for ParameterAttribute Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterObjectMarshaller"> <summary> ParameterObject Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterObjectUnmarshaller"> <summary> Response Unmarshaller for ParameterObject Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterValueMarshaller"> <summary> ParameterValue Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ParameterValueUnmarshaller"> <summary> Response Unmarshaller for ParameterValue Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineDescriptionUnmarshaller"> <summary> Response Unmarshaller for PipelineDescription Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineIdNameUnmarshaller"> <summary> Response Unmarshaller for PipelineIdName Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineObjectMarshaller"> <summary> PipelineObject Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PipelineObjectUnmarshaller"> <summary> Response Unmarshaller for PipelineObject Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.PollForTaskRequestMarshaller"> <summary> PollForTask 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.PutPipelineDefinitionRequestMarshaller"> <summary> PutPipelineDefinition 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.QueryMarshaller"> <summary> Query Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.QueryObjectsRequestMarshaller"> <summary> QueryObjects 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.RemoveTagsRequestMarshaller"> <summary> RemoveTags Request Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.RemoveTagsResponseUnmarshaller"> <summary> Response Unmarshaller for RemoveTags operation </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ReportTaskProgressRequestMarshaller"> <summary> ReportTaskProgress 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.ReportTaskRunnerHeartbeatRequestMarshaller"> <summary> ReportTaskRunnerHeartbeat 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.SelectorMarshaller"> <summary> Selector Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.SetStatusRequestMarshaller"> <summary> SetStatus 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> SetTaskStatus 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.TagMarshaller"> <summary> Tag Marshaller </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.TaskObjectUnmarshaller"> <summary> Response Unmarshaller for TaskObject Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidatePipelineDefinitionRequestMarshaller"> <summary> ValidatePipelineDefinition 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.ValidationErrorUnmarshaller"> <summary> Response Unmarshaller for ValidationError Object </summary> </member> <member name="T:Amazon.DataPipeline.Model.Internal.MarshallTransformations.ValidationWarningUnmarshaller"> <summary> Response Unmarshaller for ValidationWarning Object </summary> </member> <member name="T:Amazon.DeviceFarm.AmazonDeviceFarmClient"> <summary> Implementation for accessing DeviceFarm AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud. </summary> </member> <member name="T:Amazon.DeviceFarm.IAmazonDeviceFarm"> <summary> Interface for accessing DeviceFarm AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud. </summary> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest)"> <summary> Creates a device pool. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool service method.</param> <returns>The response from the CreateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginCreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndCreateDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDevicePool.</param> <returns>Returns a CreateDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateProject(System.String)"> <summary> Creates a new project. </summary> <param name="name">The project's name.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest)"> <summary> Creates a new project. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginCreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndCreateProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateProject.</param> <returns>Returns a CreateProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.CreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest)"> <summary> Uploads an app or test scripts. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload service method.</param> <returns>The response from the CreateUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginCreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndCreateUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateUpload.</param> <returns>Returns a CreateUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest)"> <summary> Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool service method.</param> <returns>The response from the DeleteDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginDeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndDeleteDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDevicePool.</param> <returns>Returns a DeleteDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest)"> <summary> Deletes an AWS Device Farm project, given the project ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> <returns>The response from the DeleteProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginDeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteProject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndDeleteProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteProject.</param> <returns>Returns a DeleteProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest)"> <summary> Deletes the run, given the run ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun service method.</param> <returns>The response from the DeleteRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginDeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRun operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndDeleteRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRun.</param> <returns>Returns a DeleteRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.DeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest)"> <summary> Deletes an upload given the upload ARN. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload service method.</param> <returns>The response from the DeleteUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginDeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndDeleteUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUpload.</param> <returns>Returns a DeleteUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetAccountSettings"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest)"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings service method.</param> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountSettings operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetAccountSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountSettings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountSettings.</param> <returns>Returns a GetAccountSettingsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevice(System.String)"> <summary> Gets information about a unique device type. </summary> <param name="arn">The device type's ARN.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest)"> <summary> Gets information about a unique device type. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice service method.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevice operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetDevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevice operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevice.</param> <returns>Returns a GetDeviceResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePool(System.String)"> <summary> Gets information about a device pool. </summary> <param name="arn">The device pool's ARN.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest)"> <summary> Gets information about a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool service method.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevicePool.</param> <returns>Returns a GetDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest)"> <summary> Gets information about compatibility with a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility service method.</param> <returns>The response from the GetDevicePoolCompatibility service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevicePoolCompatibility operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetDevicePoolCompatibility(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevicePoolCompatibility.</param> <returns>Returns a GetDevicePoolCompatibilityResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetJob(System.String)"> <summary> Gets information about a job. </summary> <param name="arn">The job's ARN.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetJob(Amazon.DeviceFarm.Model.GetJobRequest)"> <summary> Gets information about a job. </summary> <param name="request">Container for the necessary parameters to execute the GetJob service method.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetJob(Amazon.DeviceFarm.Model.GetJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJob operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJob operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJob operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJob.</param> <returns>Returns a GetJobResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetProject(System.String)"> <summary> Gets information about a project. </summary> <param name="arn">The project's ARN.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetProject(Amazon.DeviceFarm.Model.GetProjectRequest)"> <summary> Gets information about a project. </summary> <param name="request">Container for the necessary parameters to execute the GetProject service method.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetProject(Amazon.DeviceFarm.Model.GetProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetProject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetProject.</param> <returns>Returns a GetProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetRun(System.String)"> <summary> Gets information about a run. </summary> <param name="arn">The run's ARN.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetRun(Amazon.DeviceFarm.Model.GetRunRequest)"> <summary> Gets information about a run. </summary> <param name="request">Container for the necessary parameters to execute the GetRun service method.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetRun(Amazon.DeviceFarm.Model.GetRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRun operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRun.</param> <returns>Returns a GetRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetSuite(System.String)"> <summary> Gets information about a suite. </summary> <param name="arn">The suite's ARN.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest)"> <summary> Gets information about a suite. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite service method.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSuite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSuite operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetSuite(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSuite operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSuite.</param> <returns>Returns a GetSuiteResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetTest(System.String)"> <summary> Gets information about a test. </summary> <param name="arn">The test's ARN.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetTest(Amazon.DeviceFarm.Model.GetTestRequest)"> <summary> Gets information about a test. </summary> <param name="request">Container for the necessary parameters to execute the GetTest service method.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetTest(Amazon.DeviceFarm.Model.GetTestRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTest operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTest operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTest operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetTest(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTest operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTest.</param> <returns>Returns a GetTestResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetUpload(System.String)"> <summary> Gets information about an upload. </summary> <param name="arn">The upload's ARN.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.GetUpload(Amazon.DeviceFarm.Model.GetUploadRequest)"> <summary> Gets information about an upload. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload service method.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginGetUpload(Amazon.DeviceFarm.Model.GetUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndGetUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUpload.</param> <returns>Returns a GetUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest)"> <summary> Gets information about artifacts. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts service method.</param> <returns>The response from the ListArtifacts service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListArtifacts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListArtifacts operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListArtifacts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListArtifacts operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListArtifacts.</param> <returns>Returns a ListArtifactsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest)"> <summary> Gets information about device pools. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools service method.</param> <returns>The response from the ListDevicePools service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDevicePools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDevicePools operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListDevicePools(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDevicePools operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDevicePools.</param> <returns>Returns a ListDevicePoolsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest)"> <summary> Gets information about unique device types. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices service method.</param> <returns>The response from the ListDevices service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDevices operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListDevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDevices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDevices.</param> <returns>Returns a ListDevicesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListJobs(Amazon.DeviceFarm.Model.ListJobsRequest)"> <summary> Gets information about jobs. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListJobs(Amazon.DeviceFarm.Model.ListJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DeviceFarm.IAmazonDeviceFarm.EndListJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobs.</param> <returns>Returns a ListJobsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest)"> <summary> Gets information about projects. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects service method.</param> <returns>The response from the ListProjects service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListProjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListProjects operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListProjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListProjects operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListProjects.</param> <returns>Returns a ListProjectsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListRuns(Amazon.DeviceFarm.Model.ListRunsRequest)"> <summary> Gets information about runs. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns service method.</param> <returns>The response from the ListRuns service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListRuns(Amazon.DeviceFarm.Model.ListRunsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRuns operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRuns operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListRuns(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRuns operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRuns.</param> <returns>Returns a ListRunsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest)"> <summary> Gets information about samples. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples service method.</param> <returns>The response from the ListSamples service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSamples operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSamples operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListSamples(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSamples operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSamples.</param> <returns>Returns a ListSamplesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest)"> <summary> Gets information about suites. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites service method.</param> <returns>The response from the ListSuites service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSuites operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSuites operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListSuites(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSuites operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSuites.</param> <returns>Returns a ListSuitesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListTests(Amazon.DeviceFarm.Model.ListTestsRequest)"> <summary> Gets information about tests. </summary> <param name="request">Container for the necessary parameters to execute the ListTests service method.</param> <returns>The response from the ListTests service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListTests(Amazon.DeviceFarm.Model.ListTestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTests operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTests operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTests operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListTests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTests.</param> <returns>Returns a ListTestsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest)"> <summary> Gets information about unique problems. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems service method.</param> <returns>The response from the ListUniqueProblems service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUniqueProblems operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListUniqueProblems(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUniqueProblems.</param> <returns>Returns a ListUniqueProblemsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest)"> <summary> Gets information about uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads service method.</param> <returns>The response from the ListUploads service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUploads operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndListUploads(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUploads operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUploads.</param> <returns>Returns a ListUploadsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.ScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest)"> <summary> Schedules a run. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun service method.</param> <returns>The response from the ScheduleRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.IdempotencyException"> An entity with the same name already exists. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ScheduleRun operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScheduleRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndScheduleRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ScheduleRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScheduleRun.</param> <returns>Returns a ScheduleRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest)"> <summary> Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool service method.</param> <returns>The response from the UpdateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginUpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndUpdateDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDevicePool.</param> <returns>Returns a UpdateDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.UpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest)"> <summary> Modifies the specified project name, given the project ARN and a new name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject service method.</param> <returns>The response from the UpdateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.BeginUpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.IAmazonDeviceFarm.EndUpdateProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateProject.</param> <returns>Returns a UpdateProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Credentials and an AmazonDeviceFarmClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.#ctor(System.String,System.String,System.String,Amazon.DeviceFarm.AmazonDeviceFarmConfig)"> <summary> Constructs AmazonDeviceFarmClient with AWS Access Key ID, AWS Secret Key and an AmazonDeviceFarmClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDeviceFarmClient Configuration Object</param> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest)"> <summary> Creates a device pool. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool service method.</param> <returns>The response from the CreateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginCreateDevicePool(Amazon.DeviceFarm.Model.CreateDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndCreateDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDevicePool.</param> <returns>Returns a CreateDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateProject(System.String)"> <summary> Creates a new project. </summary> <param name="name">The project's name.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest)"> <summary> Creates a new project. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject service method.</param> <returns>The response from the CreateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginCreateProject(Amazon.DeviceFarm.Model.CreateProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndCreateProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateProject.</param> <returns>Returns a CreateProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.CreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest)"> <summary> Uploads an app or test scripts. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload service method.</param> <returns>The response from the CreateUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginCreateUpload(Amazon.DeviceFarm.Model.CreateUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndCreateUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateUpload.</param> <returns>Returns a CreateUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest)"> <summary> Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool service method.</param> <returns>The response from the DeleteDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginDeleteDevicePool(Amazon.DeviceFarm.Model.DeleteDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndDeleteDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDevicePool.</param> <returns>Returns a DeleteDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest)"> <summary> Deletes an AWS Device Farm project, given the project ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject service method.</param> <returns>The response from the DeleteProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginDeleteProject(Amazon.DeviceFarm.Model.DeleteProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteProject operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndDeleteProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteProject.</param> <returns>Returns a DeleteProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest)"> <summary> Deletes the run, given the run ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun service method.</param> <returns>The response from the DeleteRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginDeleteRun(Amazon.DeviceFarm.Model.DeleteRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRun operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndDeleteRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRun.</param> <returns>Returns a DeleteRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.DeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest)"> <summary> Deletes an upload given the upload ARN. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload service method.</param> <returns>The response from the DeleteUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginDeleteUpload(Amazon.DeviceFarm.Model.DeleteUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndDeleteUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteUpload.</param> <returns>Returns a DeleteUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetAccountSettings"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest)"> <summary> Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings service method.</param> <returns>The response from the GetAccountSettings service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetAccountSettings(Amazon.DeviceFarm.Model.GetAccountSettingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetAccountSettings operation. </summary> <param name="request">Container for the necessary parameters to execute the GetAccountSettings operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetAccountSettings operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetAccountSettings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetAccountSettings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetAccountSettings.</param> <returns>Returns a GetAccountSettingsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevice(System.String)"> <summary> Gets information about a unique device type. </summary> <param name="arn">The device type's ARN.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest)"> <summary> Gets information about a unique device type. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice service method.</param> <returns>The response from the GetDevice service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetDevice(Amazon.DeviceFarm.Model.GetDeviceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevice operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevice operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevice operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetDevice(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevice operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevice.</param> <returns>Returns a GetDeviceResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePool(System.String)"> <summary> Gets information about a device pool. </summary> <param name="arn">The device pool's ARN.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest)"> <summary> Gets information about a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool service method.</param> <returns>The response from the GetDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetDevicePool(Amazon.DeviceFarm.Model.GetDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevicePool.</param> <returns>Returns a GetDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest)"> <summary> Gets information about compatibility with a device pool. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility service method.</param> <returns>The response from the GetDevicePoolCompatibility service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetDevicePoolCompatibility(Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDevicePoolCompatibility operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDevicePoolCompatibility operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetDevicePoolCompatibility(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDevicePoolCompatibility operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDevicePoolCompatibility.</param> <returns>Returns a GetDevicePoolCompatibilityResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetJob(System.String)"> <summary> Gets information about a job. </summary> <param name="arn">The job's ARN.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetJob(Amazon.DeviceFarm.Model.GetJobRequest)"> <summary> Gets information about a job. </summary> <param name="request">Container for the necessary parameters to execute the GetJob service method.</param> <returns>The response from the GetJob service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetJob(Amazon.DeviceFarm.Model.GetJobRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetJob operation. </summary> <param name="request">Container for the necessary parameters to execute the GetJob operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetJob operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetJob(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetJob operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetJob.</param> <returns>Returns a GetJobResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetProject(System.String)"> <summary> Gets information about a project. </summary> <param name="arn">The project's ARN.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetProject(Amazon.DeviceFarm.Model.GetProjectRequest)"> <summary> Gets information about a project. </summary> <param name="request">Container for the necessary parameters to execute the GetProject service method.</param> <returns>The response from the GetProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetProject(Amazon.DeviceFarm.Model.GetProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetProject operation. </summary> <param name="request">Container for the necessary parameters to execute the GetProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetProject.</param> <returns>Returns a GetProjectResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetRun(System.String)"> <summary> Gets information about a run. </summary> <param name="arn">The run's ARN.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetRun(Amazon.DeviceFarm.Model.GetRunRequest)"> <summary> Gets information about a run. </summary> <param name="request">Container for the necessary parameters to execute the GetRun service method.</param> <returns>The response from the GetRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetRun(Amazon.DeviceFarm.Model.GetRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRun operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRun.</param> <returns>Returns a GetRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetSuite(System.String)"> <summary> Gets information about a suite. </summary> <param name="arn">The suite's ARN.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest)"> <summary> Gets information about a suite. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite service method.</param> <returns>The response from the GetSuite service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetSuite(Amazon.DeviceFarm.Model.GetSuiteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSuite operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSuite operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSuite operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetSuite(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSuite operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSuite.</param> <returns>Returns a GetSuiteResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetTest(System.String)"> <summary> Gets information about a test. </summary> <param name="arn">The test's ARN.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetTest(Amazon.DeviceFarm.Model.GetTestRequest)"> <summary> Gets information about a test. </summary> <param name="request">Container for the necessary parameters to execute the GetTest service method.</param> <returns>The response from the GetTest service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetTest(Amazon.DeviceFarm.Model.GetTestRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetTest operation. </summary> <param name="request">Container for the necessary parameters to execute the GetTest operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTest operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetTest(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetTest operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetTest.</param> <returns>Returns a GetTestResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetUpload(System.String)"> <summary> Gets information about an upload. </summary> <param name="arn">The upload's ARN.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.GetUpload(Amazon.DeviceFarm.Model.GetUploadRequest)"> <summary> Gets information about an upload. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload service method.</param> <returns>The response from the GetUpload service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginGetUpload(Amazon.DeviceFarm.Model.GetUploadRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetUpload operation. </summary> <param name="request">Container for the necessary parameters to execute the GetUpload operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetUpload operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndGetUpload(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetUpload operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetUpload.</param> <returns>Returns a GetUploadResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest)"> <summary> Gets information about artifacts. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts service method.</param> <returns>The response from the ListArtifacts service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListArtifacts(Amazon.DeviceFarm.Model.ListArtifactsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListArtifacts operation. </summary> <param name="request">Container for the necessary parameters to execute the ListArtifacts operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListArtifacts operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListArtifacts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListArtifacts operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListArtifacts.</param> <returns>Returns a ListArtifactsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest)"> <summary> Gets information about device pools. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools service method.</param> <returns>The response from the ListDevicePools service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListDevicePools(Amazon.DeviceFarm.Model.ListDevicePoolsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDevicePools operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevicePools operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDevicePools operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListDevicePools(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDevicePools operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDevicePools.</param> <returns>Returns a ListDevicePoolsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest)"> <summary> Gets information about unique device types. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices service method.</param> <returns>The response from the ListDevices service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListDevices(Amazon.DeviceFarm.Model.ListDevicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListDevices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListDevices operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDevices operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListDevices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListDevices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListDevices.</param> <returns>Returns a ListDevicesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListJobs(Amazon.DeviceFarm.Model.ListJobsRequest)"> <summary> Gets information about jobs. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs service method.</param> <returns>The response from the ListJobs service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListJobs(Amazon.DeviceFarm.Model.ListJobsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListJobs operation. </summary> <param name="request">Container for the necessary parameters to execute the ListJobs operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DeviceFarm.AmazonDeviceFarmClient.EndListJobs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListJobs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListJobs.</param> <returns>Returns a ListJobsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest)"> <summary> Gets information about projects. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects service method.</param> <returns>The response from the ListProjects service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListProjects(Amazon.DeviceFarm.Model.ListProjectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListProjects operation. </summary> <param name="request">Container for the necessary parameters to execute the ListProjects operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListProjects operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListProjects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListProjects operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListProjects.</param> <returns>Returns a ListProjectsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListRuns(Amazon.DeviceFarm.Model.ListRunsRequest)"> <summary> Gets information about runs. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns service method.</param> <returns>The response from the ListRuns service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListRuns(Amazon.DeviceFarm.Model.ListRunsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListRuns operation. </summary> <param name="request">Container for the necessary parameters to execute the ListRuns operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListRuns operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListRuns(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListRuns operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListRuns.</param> <returns>Returns a ListRunsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest)"> <summary> Gets information about samples. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples service method.</param> <returns>The response from the ListSamples service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListSamples(Amazon.DeviceFarm.Model.ListSamplesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSamples operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSamples operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSamples operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListSamples(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSamples operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSamples.</param> <returns>Returns a ListSamplesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest)"> <summary> Gets information about suites. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites service method.</param> <returns>The response from the ListSuites service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListSuites(Amazon.DeviceFarm.Model.ListSuitesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListSuites operation. </summary> <param name="request">Container for the necessary parameters to execute the ListSuites operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListSuites operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListSuites(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListSuites operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListSuites.</param> <returns>Returns a ListSuitesResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListTests(Amazon.DeviceFarm.Model.ListTestsRequest)"> <summary> Gets information about tests. </summary> <param name="request">Container for the necessary parameters to execute the ListTests service method.</param> <returns>The response from the ListTests service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListTests(Amazon.DeviceFarm.Model.ListTestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTests operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTests operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTests operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListTests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTests.</param> <returns>Returns a ListTestsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest)"> <summary> Gets information about unique problems. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems service method.</param> <returns>The response from the ListUniqueProblems service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListUniqueProblems(Amazon.DeviceFarm.Model.ListUniqueProblemsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUniqueProblems operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUniqueProblems operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListUniqueProblems(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUniqueProblems operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUniqueProblems.</param> <returns>Returns a ListUniqueProblemsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest)"> <summary> Gets information about uploads. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads service method.</param> <returns>The response from the ListUploads service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginListUploads(Amazon.DeviceFarm.Model.ListUploadsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListUploads operation. </summary> <param name="request">Container for the necessary parameters to execute the ListUploads operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListUploads operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndListUploads(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListUploads operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListUploads.</param> <returns>Returns a ListUploadsResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.ScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest)"> <summary> Schedules a run. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun service method.</param> <returns>The response from the ScheduleRun service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.IdempotencyException"> An entity with the same name already exists. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginScheduleRun(Amazon.DeviceFarm.Model.ScheduleRunRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ScheduleRun operation. </summary> <param name="request">Container for the necessary parameters to execute the ScheduleRun operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndScheduleRun operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndScheduleRun(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ScheduleRun operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScheduleRun.</param> <returns>Returns a ScheduleRunResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest)"> <summary> Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool service method.</param> <returns>The response from the UpdateDevicePool service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginUpdateDevicePool(Amazon.DeviceFarm.Model.UpdateDevicePoolRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateDevicePool operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateDevicePool operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndUpdateDevicePool(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateDevicePool operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateDevicePool.</param> <returns>Returns a UpdateDevicePoolResult from DeviceFarm.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.UpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest)"> <summary> Modifies the specified project name, given the project ARN and a new name. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject service method.</param> <returns>The response from the UpdateProject service method, as returned by DeviceFarm.</returns> <exception cref="T:Amazon.DeviceFarm.Model.ArgumentException"> An invalid argument was specified. </exception> <exception cref="T:Amazon.DeviceFarm.Model.LimitExceededException"> A limit was exceeded. </exception> <exception cref="T:Amazon.DeviceFarm.Model.NotFoundException"> The specified entity was not found. </exception> <exception cref="T:Amazon.DeviceFarm.Model.ServiceAccountException"> There was a problem with the service account. </exception> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.BeginUpdateProject(Amazon.DeviceFarm.Model.UpdateProjectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateProject operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateProject operation on AmazonDeviceFarmClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateProject operation.</returns> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmClient.EndUpdateProject(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateProject operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateProject.</param> <returns>Returns a UpdateProjectResult from DeviceFarm.</returns> </member> <member name="T:Amazon.DeviceFarm.AmazonDeviceFarmConfig"> <summary> Configuration for accessing Amazon DeviceFarm service </summary> </member> <member name="M:Amazon.DeviceFarm.AmazonDeviceFarmConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DeviceFarm.AmazonDeviceFarmConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DeviceFarm.AmazonDeviceFarmConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DeviceFarm.ArtifactCategory"> <summary> Constants used for properties of type ArtifactCategory. </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactCategory.FILE"> <summary> Constant FILE for ArtifactCategory </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactCategory.LOG"> <summary> Constant LOG for ArtifactCategory </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactCategory.SCREENSHOT"> <summary> Constant SCREENSHOT for ArtifactCategory </summary> </member> <member name="M:Amazon.DeviceFarm.ArtifactCategory.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.ArtifactCategory.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.ArtifactType"> <summary> Constants used for properties of type ArtifactType. </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPIUM_JAVA_OUTPUT"> <summary> Constant APPIUM_JAVA_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPIUM_JAVA_XML_OUTPUT"> <summary> Constant APPIUM_JAVA_XML_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPIUM_PYTHON_OUTPUT"> <summary> Constant APPIUM_PYTHON_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPIUM_PYTHON_XML_OUTPUT"> <summary> Constant APPIUM_PYTHON_XML_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPIUM_SERVER_OUTPUT"> <summary> Constant APPIUM_SERVER_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.APPLICATION_CRASH_REPORT"> <summary> Constant APPLICATION_CRASH_REPORT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.AUTOMATION_OUTPUT"> <summary> Constant AUTOMATION_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.CALABASH_JAVA_XML_OUTPUT"> <summary> Constant CALABASH_JAVA_XML_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.CALABASH_JSON_OUTPUT"> <summary> Constant CALABASH_JSON_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.CALABASH_PRETTY_OUTPUT"> <summary> Constant CALABASH_PRETTY_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.CALABASH_STANDARD_OUTPUT"> <summary> Constant CALABASH_STANDARD_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.DEVICE_LOG"> <summary> Constant DEVICE_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.EXERCISER_MONKEY_OUTPUT"> <summary> Constant EXERCISER_MONKEY_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.EXPLORER_EVENT_LOG"> <summary> Constant EXPLORER_EVENT_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.EXPLORER_SUMMARY_LOG"> <summary> Constant EXPLORER_SUMMARY_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.INSTRUMENTATION_OUTPUT"> <summary> Constant INSTRUMENTATION_OUTPUT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.MESSAGE_LOG"> <summary> Constant MESSAGE_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.RESULT_LOG"> <summary> Constant RESULT_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.SCREENSHOT"> <summary> Constant SCREENSHOT for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.SERVICE_LOG"> <summary> Constant SERVICE_LOG for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.UNKNOWN"> <summary> Constant UNKNOWN for ArtifactType </summary> </member> <member name="F:Amazon.DeviceFarm.ArtifactType.WEBKIT_LOG"> <summary> Constant WEBKIT_LOG for ArtifactType </summary> </member> <member name="M:Amazon.DeviceFarm.ArtifactType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.ArtifactType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.BillingMethod"> <summary> Constants used for properties of type BillingMethod. </summary> </member> <member name="F:Amazon.DeviceFarm.BillingMethod.METERED"> <summary> Constant METERED for BillingMethod </summary> </member> <member name="F:Amazon.DeviceFarm.BillingMethod.UNMETERED"> <summary> Constant UNMETERED for BillingMethod </summary> </member> <member name="M:Amazon.DeviceFarm.BillingMethod.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.BillingMethod.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.DeviceAttribute"> <summary> Constants used for properties of type DeviceAttribute. </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceAttribute.ARN"> <summary> Constant ARN for DeviceAttribute </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceAttribute.FORM_FACTOR"> <summary> Constant FORM_FACTOR for DeviceAttribute </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceAttribute.MANUFACTURER"> <summary> Constant MANUFACTURER for DeviceAttribute </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceAttribute.PLATFORM"> <summary> Constant PLATFORM for DeviceAttribute </summary> </member> <member name="M:Amazon.DeviceFarm.DeviceAttribute.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.DeviceAttribute.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.DeviceFormFactor"> <summary> Constants used for properties of type DeviceFormFactor. </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceFormFactor.PHONE"> <summary> Constant PHONE for DeviceFormFactor </summary> </member> <member name="F:Amazon.DeviceFarm.DeviceFormFactor.TABLET"> <summary> Constant TABLET for DeviceFormFactor </summary> </member> <member name="M:Amazon.DeviceFarm.DeviceFormFactor.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.DeviceFormFactor.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.DevicePlatform"> <summary> Constants used for properties of type DevicePlatform. </summary> </member> <member name="F:Amazon.DeviceFarm.DevicePlatform.ANDROID"> <summary> Constant ANDROID for DevicePlatform </summary> </member> <member name="F:Amazon.DeviceFarm.DevicePlatform.IOS"> <summary> Constant IOS for DevicePlatform </summary> </member> <member name="M:Amazon.DeviceFarm.DevicePlatform.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.DevicePlatform.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.DevicePoolType"> <summary> Constants used for properties of type DevicePoolType. </summary> </member> <member name="F:Amazon.DeviceFarm.DevicePoolType.CURATED"> <summary> Constant CURATED for DevicePoolType </summary> </member> <member name="F:Amazon.DeviceFarm.DevicePoolType.PRIVATE"> <summary> Constant PRIVATE for DevicePoolType </summary> </member> <member name="M:Amazon.DeviceFarm.DevicePoolType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.DevicePoolType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.ExecutionResult"> <summary> Constants used for properties of type ExecutionResult. </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.ERRORED"> <summary> Constant ERRORED for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.FAILED"> <summary> Constant FAILED for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.PASSED"> <summary> Constant PASSED for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.PENDING"> <summary> Constant PENDING for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.SKIPPED"> <summary> Constant SKIPPED for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.STOPPED"> <summary> Constant STOPPED for ExecutionResult </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionResult.WARNED"> <summary> Constant WARNED for ExecutionResult </summary> </member> <member name="M:Amazon.DeviceFarm.ExecutionResult.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.ExecutionResult.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.ExecutionStatus"> <summary> Constants used for properties of type ExecutionStatus. </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionStatus.COMPLETED"> <summary> Constant COMPLETED for ExecutionStatus </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionStatus.PENDING"> <summary> Constant PENDING for ExecutionStatus </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionStatus.PROCESSING"> <summary> Constant PROCESSING for ExecutionStatus </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionStatus.RUNNING"> <summary> Constant RUNNING for ExecutionStatus </summary> </member> <member name="F:Amazon.DeviceFarm.ExecutionStatus.SCHEDULING"> <summary> Constant SCHEDULING for ExecutionStatus </summary> </member> <member name="M:Amazon.DeviceFarm.ExecutionStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.ExecutionStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.RuleOperator"> <summary> Constants used for properties of type RuleOperator. </summary> </member> <member name="F:Amazon.DeviceFarm.RuleOperator.EQUALS_TO"> <summary> Constant EQUALS_TO for RuleOperator </summary> </member> <member name="F:Amazon.DeviceFarm.RuleOperator.GREATER_THAN"> <summary> Constant GREATER_THAN for RuleOperator </summary> </member> <member name="F:Amazon.DeviceFarm.RuleOperator.IN"> <summary> Constant IN for RuleOperator </summary> </member> <member name="F:Amazon.DeviceFarm.RuleOperator.LESS_THAN"> <summary> Constant LESS_THAN for RuleOperator </summary> </member> <member name="F:Amazon.DeviceFarm.RuleOperator.NOT_IN"> <summary> Constant NOT_IN for RuleOperator </summary> </member> <member name="M:Amazon.DeviceFarm.RuleOperator.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.RuleOperator.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.SampleType"> <summary> Constants used for properties of type SampleType. </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.CPU"> <summary> Constant CPU for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.MEMORY"> <summary> Constant MEMORY for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.NATIVE_AVG_DRAWTIME"> <summary> Constant NATIVE_AVG_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.NATIVE_FPS"> <summary> Constant NATIVE_FPS for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.NATIVE_FRAMES"> <summary> Constant NATIVE_FRAMES for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.NATIVE_MAX_DRAWTIME"> <summary> Constant NATIVE_MAX_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.NATIVE_MIN_DRAWTIME"> <summary> Constant NATIVE_MIN_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.OPENGL_AVG_DRAWTIME"> <summary> Constant OPENGL_AVG_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.OPENGL_FPS"> <summary> Constant OPENGL_FPS for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.OPENGL_FRAMES"> <summary> Constant OPENGL_FRAMES for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.OPENGL_MAX_DRAWTIME"> <summary> Constant OPENGL_MAX_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.OPENGL_MIN_DRAWTIME"> <summary> Constant OPENGL_MIN_DRAWTIME for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.RX"> <summary> Constant RX for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.RX_RATE"> <summary> Constant RX_RATE for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.THREADS"> <summary> Constant THREADS for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.TX"> <summary> Constant TX for SampleType </summary> </member> <member name="F:Amazon.DeviceFarm.SampleType.TX_RATE"> <summary> Constant TX_RATE for SampleType </summary> </member> <member name="M:Amazon.DeviceFarm.SampleType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.SampleType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.TestType"> <summary> Constants used for properties of type TestType. </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_JAVA_JUNIT"> <summary> Constant APPIUM_JAVA_JUNIT for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_JAVA_TESTNG"> <summary> Constant APPIUM_JAVA_TESTNG for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_PYTHON"> <summary> Constant APPIUM_PYTHON for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_WEB_JAVA_JUNIT"> <summary> Constant APPIUM_WEB_JAVA_JUNIT for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_WEB_JAVA_TESTNG"> <summary> Constant APPIUM_WEB_JAVA_TESTNG for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.APPIUM_WEB_PYTHON"> <summary> Constant APPIUM_WEB_PYTHON for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.BUILTIN_EXPLORER"> <summary> Constant BUILTIN_EXPLORER for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.BUILTIN_FUZZ"> <summary> Constant BUILTIN_FUZZ for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.CALABASH"> <summary> Constant CALABASH for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.INSTRUMENTATION"> <summary> Constant INSTRUMENTATION for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.UIAUTOMATION"> <summary> Constant UIAUTOMATION for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.UIAUTOMATOR"> <summary> Constant UIAUTOMATOR for TestType </summary> </member> <member name="F:Amazon.DeviceFarm.TestType.XCTEST"> <summary> Constant XCTEST for TestType </summary> </member> <member name="M:Amazon.DeviceFarm.TestType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.TestType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.UploadStatus"> <summary> Constants used for properties of type UploadStatus. </summary> </member> <member name="F:Amazon.DeviceFarm.UploadStatus.FAILED"> <summary> Constant FAILED for UploadStatus </summary> </member> <member name="F:Amazon.DeviceFarm.UploadStatus.INITIALIZED"> <summary> Constant INITIALIZED for UploadStatus </summary> </member> <member name="F:Amazon.DeviceFarm.UploadStatus.PROCESSING"> <summary> Constant PROCESSING for UploadStatus </summary> </member> <member name="F:Amazon.DeviceFarm.UploadStatus.SUCCEEDED"> <summary> Constant SUCCEEDED for UploadStatus </summary> </member> <member name="M:Amazon.DeviceFarm.UploadStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.UploadStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.UploadType"> <summary> Constants used for properties of type UploadType. </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.ANDROID_APP"> <summary> Constant ANDROID_APP for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_JAVA_JUNIT_TEST_PACKAGE"> <summary> Constant APPIUM_JAVA_JUNIT_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_JAVA_TESTNG_TEST_PACKAGE"> <summary> Constant APPIUM_JAVA_TESTNG_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_PYTHON_TEST_PACKAGE"> <summary> Constant APPIUM_PYTHON_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE"> <summary> Constant APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE"> <summary> Constant APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.APPIUM_WEB_PYTHON_TEST_PACKAGE"> <summary> Constant APPIUM_WEB_PYTHON_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.CALABASH_TEST_PACKAGE"> <summary> Constant CALABASH_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.EXTERNAL_DATA"> <summary> Constant EXTERNAL_DATA for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.INSTRUMENTATION_TEST_PACKAGE"> <summary> Constant INSTRUMENTATION_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.IOS_APP"> <summary> Constant IOS_APP for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.UIAUTOMATION_TEST_PACKAGE"> <summary> Constant UIAUTOMATION_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.UIAUTOMATOR_TEST_PACKAGE"> <summary> Constant UIAUTOMATOR_TEST_PACKAGE for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.WEB_APP"> <summary> Constant WEB_APP for UploadType </summary> </member> <member name="F:Amazon.DeviceFarm.UploadType.XCTEST_TEST_PACKAGE"> <summary> Constant XCTEST_TEST_PACKAGE for UploadType </summary> </member> <member name="M:Amazon.DeviceFarm.UploadType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DeviceFarm.UploadType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DeviceFarm.Model.AccountSettings"> <summary> A container for account-level settings within AWS Device Farm. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.AccountSettings.AwsAccountNumber"> <summary> Gets and sets the property AwsAccountNumber. <para> The AWS account number specified in the <code>AccountSettings</code> container. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.AccountSettings.UnmeteredDevices"> <summary> Gets and sets the property UnmeteredDevices. <para> Returns the unmetered devices you have purchased. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.AmazonDeviceFarmRequest"> <summary> Base class for DeviceFarm operation requests. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ArgumentException"> <summary> DeviceFarm exception </summary> </member> <member name="M:Amazon.DeviceFarm.Model.ArgumentException.#ctor(System.String)"> <summary> Constructs a new ArgumentException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DeviceFarm.Model.Artifact"> <summary> Represents the output of a test. Examples of artifacts include logs and screenshots. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Artifact.Arn"> <summary> Gets and sets the property Arn. <para> The artifact's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Artifact.Extension"> <summary> Gets and sets the property Extension. <para> The artifact's file extension. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Artifact.Name"> <summary> Gets and sets the property Name. <para> The artifact's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Artifact.Type"> <summary> Gets and sets the property Type. <para> The artifact's type. </para> <para> Allowed values include the following: </para> <ul> <li> <para> APPIUM_JAVA_OUTPUT: The Appium Java output type. </para> </li> <li> <para> APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type. </para> </li> <li> <para> APPIUM_PYTHON_OUTPUT: The Appium Python output type. </para> </li> <li> <para> APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type. </para> </li> <li> <para> APPIUM_SERVER_OUTPUT: The Appium server output type. </para> </li> <li> <para> AUTOMATION_OUTPUT: The automation output type. </para> </li> <li> <para> CALABASH_JSON_OUTPUT: The Calabash JSON output type. </para> </li> <li> <para> CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type. </para> </li> <li> <para> CALABASH_PRETTY_OUTPUT: The Calabash pretty output type. </para> </li> <li> <para> CALABASH_STANDARD_OUTPUT: The Calabash standard output type. </para> </li> <li> <para> DEVICE_LOG: The device log type. </para> </li> <li> <para> EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test. </para> </li> <li> <para> INSTRUMENTATION_OUTPUT: The instrumentation type. </para> </li> <li> <para> MESSAGE_LOG: The message log type. </para> </li> <li> <para> RESULT_LOG: The result log type. </para> </li> <li> <para> SCREENSHOT: The screenshot type. </para> </li> <li> <para> SERVICE_LOG: The service log type. </para> </li> <li> <para> UNKNOWN: An unknown type. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Artifact.Url"> <summary> Gets and sets the property Url. <para> The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Counters"> <summary> Represents entity counters. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Errored"> <summary> Gets and sets the property Errored. <para> The number of errored entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Failed"> <summary> Gets and sets the property Failed. <para> The number of failed entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Passed"> <summary> Gets and sets the property Passed. <para> The number of passed entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Skipped"> <summary> Gets and sets the property Skipped. <para> The number of skipped entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Stopped"> <summary> Gets and sets the property Stopped. <para> The number of stopped entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Total"> <summary> Gets and sets the property Total. <para> The total number of entities. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Counters.Warned"> <summary> Gets and sets the property Warned. <para> The number of warned entities. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CPU"> <summary> Represents the amount of CPU that an app is using on a physical device. <para> Note that this does not represent system-wide CPU usage. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CPU.Architecture"> <summary> Gets and sets the property Architecture. <para> The CPU's architecture, for example x86 or ARM. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CPU.Clock"> <summary> Gets and sets the property Clock. <para> The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CPU.Frequency"> <summary> Gets and sets the property Frequency. <para> The CPU's frequency. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateDevicePoolRequest"> <summary> Container for the parameters to the CreateDevicePool operation. Creates a device pool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolRequest.Description"> <summary> Gets and sets the property Description. <para> The device pool's description. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolRequest.Name"> <summary> Gets and sets the property Name. <para> The device pool's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolRequest.ProjectArn"> <summary> Gets and sets the property ProjectArn. <para> The ARN of the project for the device pool. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolRequest.Rules"> <summary> Gets and sets the property Rules. <para> The device pool's rules. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateDevicePoolResponse"> <summary> Configuration for accessing Amazon CreateDevicePool service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateDevicePoolResult"> <summary> Represents the result of a create device pool request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolResult.DevicePool"> <summary> Gets and sets the property DevicePool. <para> The newly created device pool. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateDevicePoolResponse.CreateDevicePoolResult"> <summary> Gets and sets the CreateDevicePoolResult property. Represents the output of a CreateDevicePool operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateProjectRequest"> <summary> Container for the parameters to the CreateProject operation. Creates a new project. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateProjectRequest.Name"> <summary> Gets and sets the property Name. <para> The project's name. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateProjectResponse"> <summary> Configuration for accessing Amazon CreateProject service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateProjectResult"> <summary> Represents the result of a create project request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateProjectResult.Project"> <summary> Gets and sets the property Project. <para> The newly created project. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateProjectResponse.CreateProjectResult"> <summary> Gets and sets the CreateProjectResult property. Represents the output of a CreateProject operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateUploadRequest"> <summary> Container for the parameters to the CreateUpload operation. Uploads an app or test scripts. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadRequest.ContentType"> <summary> Gets and sets the property ContentType. <para> The upload's content type (for example, "application/octet-stream"). </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadRequest.Name"> <summary> Gets and sets the property Name. <para> The upload's file name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadRequest.ProjectArn"> <summary> Gets and sets the property ProjectArn. <para> The ARN of the project for the upload. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadRequest.Type"> <summary> Gets and sets the property Type. <para> The upload's upload type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> ANDROID_APP: An Android upload. </para> </li> <li> <para> IOS_APP: An iOS upload. </para> </li> <li> <para> EXTERNAL_DATA: An external data upload. </para> </li> <li> <para> APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. </para> </li> <li> <para> APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. </para> </li> <li> <para> APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. </para> </li> <li> <para> CALABASH_TEST_PACKAGE: A Calabash test package upload. </para> </li> <li> <para> INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. </para> </li> <li> <para> UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. </para> </li> <li> <para> XCTEST_TEST_PACKAGE: An XCode test package upload. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. </para> </li> <li> <para> APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload. </para> </li> </ul> <para> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateUploadResponse"> <summary> Configuration for accessing Amazon CreateUpload service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.CreateUploadResult"> <summary> Represents the result of a create upload request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadResult.Upload"> <summary> Gets and sets the property Upload. <para> The newly created upload. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.CreateUploadResponse.CreateUploadResult"> <summary> Gets and sets the CreateUploadResult property. Represents the output of a CreateUpload operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteDevicePoolRequest"> <summary> Container for the parameters to the DeleteDevicePool operation. Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteDevicePoolRequest.Arn"> <summary> Gets and sets the property Arn. <para> Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteDevicePoolResponse"> <summary> Configuration for accessing Amazon DeleteDevicePool service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteDevicePoolResult"> <summary> Represents the result of a delete device pool request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteDevicePoolResponse.DeleteDevicePoolResult"> <summary> Gets and sets the DeleteDevicePoolResult property. Represents the output of a DeleteDevicePool operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteProjectRequest"> <summary> Container for the parameters to the DeleteProject operation. Deletes an AWS Device Farm project, given the project ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteProjectRequest.Arn"> <summary> Gets and sets the property Arn. <para> Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteProjectResponse"> <summary> Configuration for accessing Amazon DeleteProject service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteProjectResult"> <summary> Represents the result of a delete project request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteProjectResponse.DeleteProjectResult"> <summary> Gets and sets the DeleteProjectResult property. Represents the output of a DeleteProject operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteRunRequest"> <summary> Container for the parameters to the DeleteRun operation. Deletes the run, given the run ARN. <para> <b>Note</b> Deleting this resource does not stop an in-progress run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteRunRequest.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) for the run you wish to delete. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteRunResponse"> <summary> Configuration for accessing Amazon DeleteRun service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteRunResult"> <summary> Represents the result of a delete run request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteRunResponse.DeleteRunResult"> <summary> Gets and sets the DeleteRunResult property. Represents the output of a DeleteRun operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteUploadRequest"> <summary> Container for the parameters to the DeleteUpload operation. Deletes an upload given the upload ARN. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteUploadRequest.Arn"> <summary> Gets and sets the property Arn. <para> Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteUploadResponse"> <summary> Configuration for accessing Amazon DeleteUpload service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeleteUploadResult"> <summary> Represents the result of a delete upload request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeleteUploadResponse.DeleteUploadResult"> <summary> Gets and sets the DeleteUploadResult property. Represents the output of a DeleteUpload operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Device"> <summary> Represents a device type that an app is tested against. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Arn"> <summary> Gets and sets the property Arn. <para> The device's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Carrier"> <summary> Gets and sets the property Carrier. <para> The device's carrier. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Cpu"> <summary> Gets and sets the property Cpu. <para> Information about the device's CPU. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.FormFactor"> <summary> Gets and sets the property FormFactor. <para> The device's form factor. </para> <para> Allowed values include: </para> <ul> <li> <para> PHONE: The phone form factor. </para> </li> <li> <para> TABLET: The tablet form factor. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.HeapSize"> <summary> Gets and sets the property HeapSize. <para> The device's heap size, expressed in bytes. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Image"> <summary> Gets and sets the property Image. <para> The device's image name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Manufacturer"> <summary> Gets and sets the property Manufacturer. <para> The device's manufacturer name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Memory"> <summary> Gets and sets the property Memory. <para> The device's total memory size, expressed in bytes. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Model"> <summary> Gets and sets the property Model. <para> The device's model name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Name"> <summary> Gets and sets the property Name. <para> The device's display name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Os"> <summary> Gets and sets the property Os. <para> The device's operating system type. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Platform"> <summary> Gets and sets the property Platform. <para> The device's platform. </para> <para> Allowed values include: </para> <ul> <li> <para> ANDROID: The Android platform. </para> </li> <li> <para> IOS: The iOS platform. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Radio"> <summary> Gets and sets the property Radio. <para> The device's radio. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Device.Resolution"> <summary> Gets and sets the property Resolution. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DeviceMinutes"> <summary> Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeviceMinutes.Metered"> <summary> Gets and sets the property Metered. <para> When specified, represents only the sum of metered minutes used by the resource to run tests. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeviceMinutes.Total"> <summary> Gets and sets the property Total. <para> When specified, represents the total minutes used by the resource to run tests. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DeviceMinutes.Unmetered"> <summary> Gets and sets the property Unmetered. <para> When specified, represents only the sum of unmetered minutes used by the resource to run tests. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DevicePool"> <summary> Represents a collection of device types. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePool.Arn"> <summary> Gets and sets the property Arn. <para> The device pool's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePool.Description"> <summary> Gets and sets the property Description. <para> The device pool's description. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePool.Name"> <summary> Gets and sets the property Name. <para> The device pool's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePool.Rules"> <summary> Gets and sets the property Rules. <para> Information about the device pool's rules. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePool.Type"> <summary> Gets and sets the property Type. <para> The device pool's type. </para> <para> Allowed values include: </para> <ul> <li> <para> CURATED: A device pool that is created and managed by AWS Device Farm. </para> </li> <li> <para> PRIVATE: A device pool that is created and managed by the device pool developer. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.DevicePoolCompatibilityResult"> <summary> Represents a device pool compatibility result. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePoolCompatibilityResult.Compatible"> <summary> Gets and sets the property Compatible. <para> Whether the result was compatible with the device pool. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePoolCompatibilityResult.Device"> <summary> Gets and sets the property Device. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.DevicePoolCompatibilityResult.IncompatibilityMessages"> <summary> Gets and sets the property IncompatibilityMessages. <para> Information about the compatibility. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetAccountSettingsRequest"> <summary> Container for the parameters to the GetAccountSettings operation. Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetAccountSettingsResponse"> <summary> Configuration for accessing Amazon GetAccountSettings service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetAccountSettingsResult"> <summary> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetAccountSettingsResult.AccountSettings"> <summary> Gets and sets the property AccountSettings. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetAccountSettingsResponse.GetAccountSettingsResult"> <summary> Gets and sets the GetAccountSettingsResult property. Represents the output of a GetAccountSettings operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest"> <summary> Container for the parameters to the GetDevicePoolCompatibility operation. Gets information about compatibility with a device pool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest.AppArn"> <summary> Gets and sets the property AppArn. <para> The ARN of the app that is associated with the specified device pool. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest.DevicePoolArn"> <summary> Gets and sets the property DevicePoolArn. <para> The device pool's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityRequest.TestType"> <summary> Gets and sets the property TestType. <para> The test type for the specified device pool. </para> <para> Allowed values include the following: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResponse"> <summary> Configuration for accessing Amazon GetDevicePoolCompatibility service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResult"> <summary> Represents the result of describe device pool compatibility request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResult.CompatibleDevices"> <summary> Gets and sets the property CompatibleDevices. <para> Information about compatible devices. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResult.IncompatibleDevices"> <summary> Gets and sets the property IncompatibleDevices. <para> Information about incompatible devices. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolCompatibilityResponse.GetDevicePoolCompatibilityResult"> <summary> Gets and sets the GetDevicePoolCompatibilityResult property. Represents the output of a GetDevicePoolCompatibility operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolRequest"> <summary> Container for the parameters to the GetDevicePool operation. Gets information about a device pool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolRequest.Arn"> <summary> Gets and sets the property Arn. <para> The device pool's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolResponse"> <summary> Configuration for accessing Amazon GetDevicePool service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDevicePoolResult"> <summary> Represents the result of a get device pool request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolResult.DevicePool"> <summary> Gets and sets the property DevicePool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDevicePoolResponse.GetDevicePoolResult"> <summary> Gets and sets the GetDevicePoolResult property. Represents the output of a GetDevicePool operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDeviceRequest"> <summary> Container for the parameters to the GetDevice operation. Gets information about a unique device type. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDeviceRequest.Arn"> <summary> Gets and sets the property Arn. <para> The device type's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDeviceResponse"> <summary> Configuration for accessing Amazon GetDevice service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetDeviceResult"> <summary> Represents the result of a get device request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDeviceResult.Device"> <summary> Gets and sets the property Device. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetDeviceResponse.GetDeviceResult"> <summary> Gets and sets the GetDeviceResult property. Represents the output of a GetDevice operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetJobRequest"> <summary> Container for the parameters to the GetJob operation. Gets information about a job. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetJobRequest.Arn"> <summary> Gets and sets the property Arn. <para> The job's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetJobResponse"> <summary> Configuration for accessing Amazon GetJob service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetJobResult"> <summary> Represents the result of a get job request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetJobResult.Job"> <summary> Gets and sets the property Job. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetJobResponse.GetJobResult"> <summary> Gets and sets the GetJobResult property. Represents the output of a GetJob operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetProjectRequest"> <summary> Container for the parameters to the GetProject operation. Gets information about a project. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetProjectRequest.Arn"> <summary> Gets and sets the property Arn. <para> The project's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetProjectResponse"> <summary> Configuration for accessing Amazon GetProject service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetProjectResult"> <summary> Represents the result of a get project request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetProjectResult.Project"> <summary> Gets and sets the property Project. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetProjectResponse.GetProjectResult"> <summary> Gets and sets the GetProjectResult property. Represents the output of a GetProject operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetRunRequest"> <summary> Container for the parameters to the GetRun operation. Gets information about a run. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetRunRequest.Arn"> <summary> Gets and sets the property Arn. <para> The run's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetRunResponse"> <summary> Configuration for accessing Amazon GetRun service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetRunResult"> <summary> Represents the result of a get run request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetRunResult.Run"> <summary> Gets and sets the property Run. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetRunResponse.GetRunResult"> <summary> Gets and sets the GetRunResult property. Represents the output of a GetRun operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetSuiteRequest"> <summary> Container for the parameters to the GetSuite operation. Gets information about a suite. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetSuiteRequest.Arn"> <summary> Gets and sets the property Arn. <para> The suite's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetSuiteResponse"> <summary> Configuration for accessing Amazon GetSuite service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetSuiteResult"> <summary> Represents the result of a get suite request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetSuiteResult.Suite"> <summary> Gets and sets the property Suite. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetSuiteResponse.GetSuiteResult"> <summary> Gets and sets the GetSuiteResult property. Represents the output of a GetSuite operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetTestRequest"> <summary> Container for the parameters to the GetTest operation. Gets information about a test. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetTestRequest.Arn"> <summary> Gets and sets the property Arn. <para> The test's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetTestResponse"> <summary> Configuration for accessing Amazon GetTest service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetTestResult"> <summary> Represents the result of a get test request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetTestResult.Test"> <summary> Gets and sets the property Test. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetTestResponse.GetTestResult"> <summary> Gets and sets the GetTestResult property. Represents the output of a GetTest operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetUploadRequest"> <summary> Container for the parameters to the GetUpload operation. Gets information about an upload. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetUploadRequest.Arn"> <summary> Gets and sets the property Arn. <para> The upload's ARN. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetUploadResponse"> <summary> Configuration for accessing Amazon GetUpload service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.GetUploadResult"> <summary> Represents the result of a get upload request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetUploadResult.Upload"> <summary> Gets and sets the property Upload. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.GetUploadResponse.GetUploadResult"> <summary> Gets and sets the GetUploadResult property. Represents the output of a GetUpload operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.IdempotencyException"> <summary> DeviceFarm exception </summary> </member> <member name="M:Amazon.DeviceFarm.Model.IdempotencyException.#ctor(System.String)"> <summary> Constructs a new IdempotencyException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DeviceFarm.Model.IncompatibilityMessage"> <summary> Represents information about incompatibility. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.IncompatibilityMessage.Message"> <summary> Gets and sets the property Message. <para> A message about the incompatibility. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.IncompatibilityMessage.Type"> <summary> Gets and sets the property Type. <para> The type of incompatibility. </para> <para> Allowed values include: </para> <ul> <li> <para> ARN: The ARN. </para> </li> <li> <para> FORM_FACTOR: The form factor (for example, phone or tablet). </para> </li> <li> <para> MANUFACTURER: The manufacturer. </para> </li> <li> <para> PLATFORM: The platform (for example, Android or iOS). </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Job"> <summary> Represents a device. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Arn"> <summary> Gets and sets the property Arn. <para> The job's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Counters"> <summary> Gets and sets the property Counters. <para> The job's result counters. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Created"> <summary> Gets and sets the property Created. <para> When the job was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Device"> <summary> Gets and sets the property Device. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.DeviceMinutes"> <summary> Gets and sets the property DeviceMinutes. <para> Represents the total (metered or unmetered) minutes used by the job. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Message"> <summary> Gets and sets the property Message. <para> A message about the job's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Name"> <summary> Gets and sets the property Name. <para> The job's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Result"> <summary> Gets and sets the property Result. <para> The job's result. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Started"> <summary> Gets and sets the property Started. <para> The job's start time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Status"> <summary> Gets and sets the property Status. <para> The job's status. </para> <para> Allowed values include: </para> <ul> <li> <para> COMPLETED: A completed status. </para> </li> <li> <para> PENDING: A pending status. </para> </li> <li> <para> PROCESSING: A processing status. </para> </li> <li> <para> RUNNING: A running status. </para> </li> <li> <para> SCHEDULING: A scheduling status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Stopped"> <summary> Gets and sets the property Stopped. <para> The job's stop time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Job.Type"> <summary> Gets and sets the property Type. <para> The job's type. </para> <para> Allowed values include the following: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.LimitExceededException"> <summary> DeviceFarm exception </summary> </member> <member name="M:Amazon.DeviceFarm.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.DeviceFarm.Model.ListArtifactsRequest"> <summary> Container for the parameters to the ListArtifacts operation. Gets information about artifacts. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The Run, Job, Suite, or Test ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsRequest.Type"> <summary> Gets and sets the property Type. <para> The artifacts' type. </para> <para> Allowed values include: </para> <ul> <li>FILE: The artifacts are files.</li> <li>LOG: The artifacts are logs.</li> <li>SCREENSHOT: The artifacts are screenshots.</li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListArtifactsResponse"> <summary> Configuration for accessing Amazon ListArtifacts service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListArtifactsResult"> <summary> Represents the result of a list artifacts operation. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsResult.Artifacts"> <summary> Gets and sets the property Artifacts. <para> Information about the artifacts. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListArtifactsResponse.ListArtifactsResult"> <summary> Gets and sets the ListArtifactsResult property. Represents the output of a ListArtifacts operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicePoolsRequest"> <summary> Container for the parameters to the ListDevicePools operation. Gets information about device pools. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The project ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsRequest.Type"> <summary> Gets and sets the property Type. <para> The device pools' type. </para> <para> Allowed values include: </para> <ul> <li> <para> CURATED: A device pool that is created and managed by AWS Device Farm. </para> </li> <li> <para> PRIVATE: A device pool that is created and managed by the device pool developer. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicePoolsResponse"> <summary> Configuration for accessing Amazon ListDevicePools service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicePoolsResult"> <summary> Represents the result of a list device pools request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsResult.DevicePools"> <summary> Gets and sets the property DevicePools. <para> Information about the device pools. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicePoolsResponse.ListDevicePoolsResult"> <summary> Gets and sets the ListDevicePoolsResult property. Represents the output of a ListDevicePools operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicesRequest"> <summary> Container for the parameters to the ListDevices operation. Gets information about unique device types. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicesRequest.Arn"> <summary> Gets and sets the property Arn. <para> The device types' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicesResponse"> <summary> Configuration for accessing Amazon ListDevices service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListDevicesResult"> <summary> Represents the result of a list devices operation. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicesResult.Devices"> <summary> Gets and sets the property Devices. <para> Information about the devices. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListDevicesResponse.ListDevicesResult"> <summary> Gets and sets the ListDevicesResult property. Represents the output of a ListDevices operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListJobsRequest"> <summary> Container for the parameters to the ListJobs operation. Gets information about jobs. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListJobsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The jobs' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListJobsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListJobsResponse"> <summary> Configuration for accessing Amazon ListJobs service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListJobsResult"> <summary> Represents the result of a list jobs request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListJobsResult.Jobs"> <summary> Gets and sets the property Jobs. <para> Information about the jobs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListJobsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListJobsResponse.ListJobsResult"> <summary> Gets and sets the ListJobsResult property. Represents the output of a ListJobs operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListProjectsRequest"> <summary> Container for the parameters to the ListProjects operation. Gets information about projects. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListProjectsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The projects' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListProjectsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListProjectsResponse"> <summary> Configuration for accessing Amazon ListProjects service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListProjectsResult"> <summary> Represents the result of a list projects request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListProjectsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListProjectsResult.Projects"> <summary> Gets and sets the property Projects. <para> Information about the projects. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListProjectsResponse.ListProjectsResult"> <summary> Gets and sets the ListProjectsResult property. Represents the output of a ListProjects operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListRunsRequest"> <summary> Container for the parameters to the ListRuns operation. Gets information about runs. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListRunsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The runs' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListRunsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListRunsResponse"> <summary> Configuration for accessing Amazon ListRuns service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListRunsResult"> <summary> Represents the result of a list runs request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListRunsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListRunsResult.Runs"> <summary> Gets and sets the property Runs. <para> Information about the runs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListRunsResponse.ListRunsResult"> <summary> Gets and sets the ListRunsResult property. Represents the output of a ListRuns operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSamplesRequest"> <summary> Container for the parameters to the ListSamples operation. Gets information about samples. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSamplesRequest.Arn"> <summary> Gets and sets the property Arn. <para> The samples' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSamplesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSamplesResponse"> <summary> Configuration for accessing Amazon ListSamples service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSamplesResult"> <summary> Represents the result of a list samples request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSamplesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSamplesResult.Samples"> <summary> Gets and sets the property Samples. <para> Information about the samples. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSamplesResponse.ListSamplesResult"> <summary> Gets and sets the ListSamplesResult property. Represents the output of a ListSamples operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSuitesRequest"> <summary> Container for the parameters to the ListSuites operation. Gets information about suites. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSuitesRequest.Arn"> <summary> Gets and sets the property Arn. <para> The suites' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSuitesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSuitesResponse"> <summary> Configuration for accessing Amazon ListSuites service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListSuitesResult"> <summary> Represents the result of a list suites request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSuitesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSuitesResult.Suites"> <summary> Gets and sets the property Suites. <para> Information about the suites. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListSuitesResponse.ListSuitesResult"> <summary> Gets and sets the ListSuitesResult property. Represents the output of a ListSuites operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListTestsRequest"> <summary> Container for the parameters to the ListTests operation. Gets information about tests. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListTestsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The tests' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListTestsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListTestsResponse"> <summary> Configuration for accessing Amazon ListTests service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListTestsResult"> <summary> Represents the result of a list tests request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListTestsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListTestsResult.Tests"> <summary> Gets and sets the property Tests. <para> Information about the tests. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListTestsResponse.ListTestsResult"> <summary> Gets and sets the ListTestsResult property. Represents the output of a ListTests operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUniqueProblemsRequest"> <summary> Container for the parameters to the ListUniqueProblems operation. Gets information about unique problems. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUniqueProblemsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The unique problems' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUniqueProblemsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUniqueProblemsResponse"> <summary> Configuration for accessing Amazon ListUniqueProblems service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUniqueProblemsResult"> <summary> Represents the result of a list unique problems request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUniqueProblemsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUniqueProblemsResult.UniqueProblems"> <summary> Gets and sets the property UniqueProblems. <para> Information about the unique problems. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUniqueProblemsResponse.ListUniqueProblemsResult"> <summary> Gets and sets the ListUniqueProblemsResult property. Represents the output of a ListUniqueProblems operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUploadsRequest"> <summary> Container for the parameters to the ListUploads operation. Gets information about uploads. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUploadsRequest.Arn"> <summary> Gets and sets the property Arn. <para> The uploads' ARNs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUploadsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUploadsResponse"> <summary> Configuration for accessing Amazon ListUploads service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ListUploadsResult"> <summary> Represents the result of a list uploads request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUploadsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUploadsResult.Uploads"> <summary> Gets and sets the property Uploads. <para> Information about the uploads. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ListUploadsResponse.ListUploadsResult"> <summary> Gets and sets the ListUploadsResult property. Represents the output of a ListUploads operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Location"> <summary> Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491). <para> Elevation is currently not supported. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Location.Latitude"> <summary> Gets and sets the property Latitude. <para> The latitude. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Location.Longitude"> <summary> Gets and sets the property Longitude. <para> The longitude. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.NotFoundException"> <summary> DeviceFarm exception </summary> </member> <member name="M:Amazon.DeviceFarm.Model.NotFoundException.#ctor(System.String)"> <summary> Constructs a new NotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DeviceFarm.Model.Problem"> <summary> Represents a specific warning or failure. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Device"> <summary> Gets and sets the property Device. <para> Information about the associated device. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Job"> <summary> Gets and sets the property Job. <para> Information about the associated job. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Message"> <summary> Gets and sets the property Message. <para> A message about the problem's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Result"> <summary> Gets and sets the property Result. <para> The problem's result. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Run"> <summary> Gets and sets the property Run. <para> Information about the associated run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Suite"> <summary> Gets and sets the property Suite. <para> Information about the associated suite. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Problem.Test"> <summary> Gets and sets the property Test. <para> Information about the associated test. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ProblemDetail"> <summary> Information about a problem detail. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ProblemDetail.Arn"> <summary> Gets and sets the property Arn. <para> The problem detail's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ProblemDetail.Name"> <summary> Gets and sets the property Name. <para> The problem detail's name. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Project"> <summary> Represents an operating-system neutral workspace for running and managing tests. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Project.Arn"> <summary> Gets and sets the property Arn. <para> The project's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Project.Created"> <summary> Gets and sets the property Created. <para> When the project was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Project.Name"> <summary> Gets and sets the property Name. <para> The project's name. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Radios"> <summary> Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Radios.Bluetooth"> <summary> Gets and sets the property Bluetooth. <para> True if Bluetooth is enabled at the beginning of the test; otherwise, false. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Radios.Gps"> <summary> Gets and sets the property Gps. <para> True if GPS is enabled at the beginning of the test; otherwise, false. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Radios.Nfc"> <summary> Gets and sets the property Nfc. <para> True if NFC is enabled at the beginning of the test; otherwise, false. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Radios.Wifi"> <summary> Gets and sets the property Wifi. <para> True if Wi-Fi is enabled at the beginning of the test; otherwise, false. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Resolution"> <summary> Represents the screen resolution of a device in height and width, expressed in pixels. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Resolution.Height"> <summary> Gets and sets the property Height. <para> The screen resolution's height, expressed in pixels. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Resolution.Width"> <summary> Gets and sets the property Width. <para> The screen resolution's width, expressed in pixels. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Rule"> <summary> Represents a condition for a device pool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Rule.Attribute"> <summary> Gets and sets the property Attribute. <para> The rule's attribute. </para> <para> Allowed values include: </para> <ul> <li> <para> ARN: The ARN. </para> </li> <li> <para> FORM_FACTOR: The form factor (for example, phone or tablet). </para> </li> <li> <para> MANUFACTURER: The manufacturer. </para> </li> <li> <para> PLATFORM: The platform (for example, Android or iOS). </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Rule.Operator"> <summary> Gets and sets the property Operator. <para> The rule's operator. </para> <ul> <li> <para> EQUALS: The equals operator. </para> </li> <li> <para> GREATER_THAN: The greater-than operator. </para> </li> <li> <para> IN: The in operator. </para> </li> <li> <para> LESS_THAN: The less-than operator. </para> </li> <li> <para> NOT_IN: The not-in operator. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Rule.Value"> <summary> Gets and sets the property Value. <para> The rule's value. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Run"> <summary> Represents an app on a set of devices with a specific test and configuration. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Arn"> <summary> Gets and sets the property Arn. <para> The run's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.BillingMethod"> <summary> Gets and sets the property BillingMethod. <para> Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>unmetered</code>. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.CompletedJobs"> <summary> Gets and sets the property CompletedJobs. <para> The total number of completed jobs. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Counters"> <summary> Gets and sets the property Counters. <para> The run's result counters. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Created"> <summary> Gets and sets the property Created. <para> When the run was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.DeviceMinutes"> <summary> Gets and sets the property DeviceMinutes. <para> Represents the total (metered or unmetered) minutes used by the test run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Message"> <summary> Gets and sets the property Message. <para> A message about the run's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Name"> <summary> Gets and sets the property Name. <para> The run's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Platform"> <summary> Gets and sets the property Platform. <para> The run's platform. </para> <para> Allowed values include: </para> <ul> <li> <para> ANDROID: The Android platform. </para> </li> <li> <para> IOS: The iOS platform. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Result"> <summary> Gets and sets the property Result. <para> The run's result. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Started"> <summary> Gets and sets the property Started. <para> The run's start time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Status"> <summary> Gets and sets the property Status. <para> The run's status. </para> <para> Allowed values include: </para> <ul> <li> <para> COMPLETED: A completed status. </para> </li> <li> <para> PENDING: A pending status. </para> </li> <li> <para> PROCESSING: A processing status. </para> </li> <li> <para> RUNNING: A running status. </para> </li> <li> <para> SCHEDULING: A scheduling status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Stopped"> <summary> Gets and sets the property Stopped. <para> The run's stop time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.TotalJobs"> <summary> Gets and sets the property TotalJobs. <para> The total number of jobs for the run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Run.Type"> <summary> Gets and sets the property Type. <para> The run's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Sample"> <summary> Represents a sample of performance data. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Sample.Arn"> <summary> Gets and sets the property Arn. <para> The sample's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Sample.Type"> <summary> Gets and sets the property Type. <para> The sample's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage. </para> </li> <li> <para> MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes. </para> </li> <li> <para> NATIVE_AVG_DRAWTIME </para> </li> <li> <para> NATIVE_FPS </para> </li> <li> <para> NATIVE_FRAMES </para> </li> <li> <para> NATIVE_MAX_DRAWTIME </para> </li> <li> <para> NATIVE_MIN_DRAWTIME </para> </li> <li> <para> OPENGL_AVG_DRAWTIME </para> </li> <li> <para> OPENGL_FPS </para> </li> <li> <para> OPENGL_FRAMES </para> </li> <li> <para> OPENGL_MAX_DRAWTIME </para> </li> <li> <para> OPENGL_MIN_DRAWTIME </para> </li> <li> <para> RX </para> </li> <li> <para> RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process. </para> </li> <li> <para> THREADS: A threads sample type. This is expressed as the total number of threads per app process. </para> </li> <li> <para> TX </para> </li> <li> <para> TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Sample.Url"> <summary> Gets and sets the property Url. <para> The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ScheduleRunConfiguration"> <summary> Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.AuxiliaryApps"> <summary> Gets and sets the property AuxiliaryApps. <para> A list of auxiliary apps for the run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.BillingMethod"> <summary> Gets and sets the property BillingMethod. <para> Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>unmetered</code>. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.ExtraDataPackageArn"> <summary> Gets and sets the property ExtraDataPackageArn. <para> The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.Locale"> <summary> Gets and sets the property Locale. <para> Information about the locale that is used for the run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.Location"> <summary> Gets and sets the property Location. <para> Information about the location that is used for the run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.NetworkProfileArn"> <summary> Gets and sets the property NetworkProfileArn. <para> Reserved for internal use. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunConfiguration.Radios"> <summary> Gets and sets the property Radios. <para> Information about the radio states for the run. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ScheduleRunRequest"> <summary> Container for the parameters to the ScheduleRun operation. Schedules a run. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.AppArn"> <summary> Gets and sets the property AppArn. <para> The ARN of the app to schedule a run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.Configuration"> <summary> Gets and sets the property Configuration. <para> Information about the settings for the run to be scheduled. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.DevicePoolArn"> <summary> Gets and sets the property DevicePoolArn. <para> The ARN of the device pool for the run to be scheduled. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.Name"> <summary> Gets and sets the property Name. <para> The name for the run to be scheduled. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.ProjectArn"> <summary> Gets and sets the property ProjectArn. <para> The ARN of the project for the run to be scheduled. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunRequest.Test"> <summary> Gets and sets the property Test. <para> Information about the test for the run to be scheduled. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ScheduleRunResponse"> <summary> Configuration for accessing Amazon ScheduleRun service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ScheduleRunResult"> <summary> Represents the result of a schedule run request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunResult.Run"> <summary> Gets and sets the property Run. <para> Information about the scheduled run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunResponse.ScheduleRunResult"> <summary> Gets and sets the ScheduleRunResult property. Represents the output of a ScheduleRun operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ScheduleRunTest"> <summary> Represents additional test settings. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunTest.Filter"> <summary> Gets and sets the property Filter. <para> The test's filter. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunTest.Parameters"> <summary> Gets and sets the property Parameters. <para> The test's parameters, such as test framework parameters and fixture settings. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunTest.TestPackageArn"> <summary> Gets and sets the property TestPackageArn. <para> The ARN of the uploaded test that will be run. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.ScheduleRunTest.Type"> <summary> Gets and sets the property Type. <para> The test's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.ServiceAccountException"> <summary> DeviceFarm exception </summary> </member> <member name="M:Amazon.DeviceFarm.Model.ServiceAccountException.#ctor(System.String)"> <summary> Constructs a new ServiceAccountException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DeviceFarm.Model.Suite"> <summary> Represents a collection of one or more tests. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Arn"> <summary> Gets and sets the property Arn. <para> The suite's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Counters"> <summary> Gets and sets the property Counters. <para> The suite's result counters. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Created"> <summary> Gets and sets the property Created. <para> When the suite was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.DeviceMinutes"> <summary> Gets and sets the property DeviceMinutes. <para> Represents the total (metered or unmetered) minutes used by the test suite. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Message"> <summary> Gets and sets the property Message. <para> A message about the suite's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Name"> <summary> Gets and sets the property Name. <para> The suite's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Result"> <summary> Gets and sets the property Result. <para> The suite's result. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Started"> <summary> Gets and sets the property Started. <para> The suite's start time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Status"> <summary> Gets and sets the property Status. <para> The suite's status. </para> <para> Allowed values include: </para> <ul> <li> <para> COMPLETED: A completed status. </para> </li> <li> <para> PENDING: A pending status. </para> </li> <li> <para> PROCESSING: A processing status. </para> </li> <li> <para> RUNNING: A running status. </para> </li> <li> <para> SCHEDULING: A scheduling status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Stopped"> <summary> Gets and sets the property Stopped. <para> The suite's stop time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Suite.Type"> <summary> Gets and sets the property Type. <para> The suite's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Test"> <summary> Represents a condition that is evaluated. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Arn"> <summary> Gets and sets the property Arn. <para> The test's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Counters"> <summary> Gets and sets the property Counters. <para> The test's result counters. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Created"> <summary> Gets and sets the property Created. <para> When the test was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.DeviceMinutes"> <summary> Gets and sets the property DeviceMinutes. <para> Represents the total (metered or unmetered) minutes used by the test. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Message"> <summary> Gets and sets the property Message. <para> A message about the test's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Name"> <summary> Gets and sets the property Name. <para> The test's name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Result"> <summary> Gets and sets the property Result. <para> The test's result. </para> <para> Allowed values include: </para> <ul> <li> <para> ERRORED: An error condition. </para> </li> <li> <para> FAILED: A failed condition. </para> </li> <li> <para> SKIPPED: A skipped condition. </para> </li> <li> <para> STOPPED: A stopped condition. </para> </li> <li> <para> PASSED: A passing condition. </para> </li> <li> <para> PENDING: A pending condition. </para> </li> <li> <para> WARNED: A warning condition. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Started"> <summary> Gets and sets the property Started. <para> The test's start time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Status"> <summary> Gets and sets the property Status. <para> The test's status. </para> <para> Allowed values include: </para> <ul> <li> <para> COMPLETED: A completed status. </para> </li> <li> <para> PENDING: A pending status. </para> </li> <li> <para> PROCESSING: A processing status. </para> </li> <li> <para> RUNNING: A running status. </para> </li> <li> <para> SCHEDULING: A scheduling status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Stopped"> <summary> Gets and sets the property Stopped. <para> The test's stop time. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Test.Type"> <summary> Gets and sets the property Type. <para> The test's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> BUILTIN_FUZZ: The built-in fuzz type. </para> </li> <li> <para> BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time. </para> </li> <li> <para> APPIUM_JAVA_JUNIT: The Appium Java JUnit type. </para> </li> <li> <para> APPIUM_JAVA_TESTNG: The Appium Java TestNG type. </para> </li> <li> <para> APPIUM_PYTHON: The Appium Python type. </para> </li> <li> <para> CALABASH: The Calabash type. </para> </li> <li> <para> INSTRUMENTATION: The Instrumentation type. </para> </li> <li> <para> UIAUTOMATION: The uiautomation type. </para> </li> <li> <para> UIAUTOMATOR: The uiautomator type. </para> </li> <li> <para> XCTEST: The XCode test type. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps. </para> </li> <li> <para> APPIUM_WEB_PYTHON: The Appium Python type for Web apps. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UniqueProblem"> <summary> A collection of one or more problems, grouped by their result. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UniqueProblem.Message"> <summary> Gets and sets the property Message. <para> A message about the unique problems' result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UniqueProblem.Problems"> <summary> Gets and sets the property Problems. <para> Information about the problems. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateDevicePoolRequest"> <summary> Container for the parameters to the UpdateDevicePool operation. Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all). </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolRequest.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolRequest.Description"> <summary> Gets and sets the property Description. <para> A description of the device pool you wish to update. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolRequest.Name"> <summary> Gets and sets the property Name. <para> A string representing the name of the device pool you wish to update. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolRequest.Rules"> <summary> Gets and sets the property Rules. <para> Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateDevicePoolResponse"> <summary> Configuration for accessing Amazon UpdateDevicePool service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateDevicePoolResult"> <summary> Represents the result of an update device pool request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolResult.DevicePool"> <summary> Gets and sets the property DevicePool. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateDevicePoolResponse.UpdateDevicePoolResult"> <summary> Gets and sets the UpdateDevicePoolResult property. Represents the output of a UpdateDevicePool operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateProjectRequest"> <summary> Container for the parameters to the UpdateProject operation. Modifies the specified project name, given the project ARN and a new name. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateProjectRequest.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the project whose name you wish to update. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateProjectRequest.Name"> <summary> Gets and sets the property Name. <para> A string representing the new name of the project that you are updating. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateProjectResponse"> <summary> Configuration for accessing Amazon UpdateProject service </summary> </member> <member name="T:Amazon.DeviceFarm.Model.UpdateProjectResult"> <summary> Represents the result of an update project request. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateProjectResult.Project"> <summary> Gets and sets the property Project. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.UpdateProjectResponse.UpdateProjectResult"> <summary> Gets and sets the UpdateProjectResult property. Represents the output of a UpdateProject operation. </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Upload"> <summary> An app or a set of one or more tests to upload or that have been uploaded. </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Arn"> <summary> Gets and sets the property Arn. <para> The upload's ARN. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.ContentType"> <summary> Gets and sets the property ContentType. <para> The upload's content type (for example, "application/octet-stream"). </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Created"> <summary> Gets and sets the property Created. <para> When the upload was created. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Message"> <summary> Gets and sets the property Message. <para> A message about the upload's result. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Metadata"> <summary> Gets and sets the property Metadata. <para> The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Name"> <summary> Gets and sets the property Name. <para> The upload's file name. </para> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Status"> <summary> Gets and sets the property Status. <para> The upload's status. </para> <para> Must be one of the following values: </para> <ul> <li> <para> FAILED: A failed status. </para> </li> <li> <para> INITIALIZED: An initialized status. </para> </li> <li> <para> PROCESSING: A processing status. </para> </li> <li> <para> SUCCEEDED: A succeeded status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Type"> <summary> Gets and sets the property Type. <para> The upload's type. </para> <para> Must be one of the following values: </para> <ul> <li> <para> ANDROID_APP: An Android upload. </para> </li> <li> <para> IOS_APP: An iOS upload. </para> </li> <li> <para> EXTERNAL_DATA: An external data upload. </para> </li> <li> <para> APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. </para> </li> <li> <para> APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. </para> </li> <li> <para> APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload. </para> </li> <li> <para> CALABASH_TEST_PACKAGE: A Calabash test package upload. </para> </li> <li> <para> INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload. </para> </li> <li> <para> UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload. </para> </li> <li> <para> XCTEST_TEST_PACKAGE: An XCode test package upload. </para> </li> <li> <para> APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload. </para> </li> <li> <para> APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload. </para> </li> <li> <para> APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DeviceFarm.Model.Upload.Url"> <summary> Gets and sets the property Url. <para> The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request. </para> </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.AccountSettingsUnmarshaller"> <summary> Response Unmarshaller for AccountSettings Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ArtifactUnmarshaller"> <summary> Response Unmarshaller for Artifact Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CountersUnmarshaller"> <summary> Response Unmarshaller for Counters Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CPUUnmarshaller"> <summary> Response Unmarshaller for CPU Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateDevicePoolRequestMarshaller"> <summary> CreateDevicePool Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateDevicePoolResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDevicePool operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateProjectRequestMarshaller"> <summary> CreateProject Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateProjectResponseUnmarshaller"> <summary> Response Unmarshaller for CreateProject operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateUploadRequestMarshaller"> <summary> CreateUpload Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.CreateUploadResponseUnmarshaller"> <summary> Response Unmarshaller for CreateUpload operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteDevicePoolRequestMarshaller"> <summary> DeleteDevicePool Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteDevicePoolResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDevicePool operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteProjectRequestMarshaller"> <summary> DeleteProject Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteProjectResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteProject operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteRunRequestMarshaller"> <summary> DeleteRun Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteRunResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRun operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteUploadRequestMarshaller"> <summary> DeleteUpload Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeleteUploadResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteUpload operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeviceMinutesUnmarshaller"> <summary> Response Unmarshaller for DeviceMinutes Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DevicePoolCompatibilityResultUnmarshaller"> <summary> Response Unmarshaller for DevicePoolCompatibilityResult Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DevicePoolUnmarshaller"> <summary> Response Unmarshaller for DevicePool Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.DeviceUnmarshaller"> <summary> Response Unmarshaller for Device Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetAccountSettingsRequestMarshaller"> <summary> GetAccountSettings Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetAccountSettingsResponseUnmarshaller"> <summary> Response Unmarshaller for GetAccountSettings operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDevicePoolCompatibilityRequestMarshaller"> <summary> GetDevicePoolCompatibility Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDevicePoolCompatibilityResponseUnmarshaller"> <summary> Response Unmarshaller for GetDevicePoolCompatibility operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDevicePoolRequestMarshaller"> <summary> GetDevicePool Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDevicePoolResponseUnmarshaller"> <summary> Response Unmarshaller for GetDevicePool operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDeviceRequestMarshaller"> <summary> GetDevice Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetDeviceResponseUnmarshaller"> <summary> Response Unmarshaller for GetDevice operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetJobRequestMarshaller"> <summary> GetJob Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetJobResponseUnmarshaller"> <summary> Response Unmarshaller for GetJob operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetProjectRequestMarshaller"> <summary> GetProject Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetProjectResponseUnmarshaller"> <summary> Response Unmarshaller for GetProject operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetRunRequestMarshaller"> <summary> GetRun Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetRunResponseUnmarshaller"> <summary> Response Unmarshaller for GetRun operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetSuiteRequestMarshaller"> <summary> GetSuite Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetSuiteResponseUnmarshaller"> <summary> Response Unmarshaller for GetSuite operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetTestRequestMarshaller"> <summary> GetTest Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetTestResponseUnmarshaller"> <summary> Response Unmarshaller for GetTest operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetUploadRequestMarshaller"> <summary> GetUpload Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.GetUploadResponseUnmarshaller"> <summary> Response Unmarshaller for GetUpload operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.IncompatibilityMessageUnmarshaller"> <summary> Response Unmarshaller for IncompatibilityMessage Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.JobUnmarshaller"> <summary> Response Unmarshaller for Job Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListArtifactsRequestMarshaller"> <summary> ListArtifacts Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListArtifactsResponseUnmarshaller"> <summary> Response Unmarshaller for ListArtifacts operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListDevicePoolsRequestMarshaller"> <summary> ListDevicePools Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListDevicePoolsResponseUnmarshaller"> <summary> Response Unmarshaller for ListDevicePools operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListDevicesRequestMarshaller"> <summary> ListDevices Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListDevicesResponseUnmarshaller"> <summary> Response Unmarshaller for ListDevices operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListJobsRequestMarshaller"> <summary> ListJobs Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListJobsResponseUnmarshaller"> <summary> Response Unmarshaller for ListJobs operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListProjectsRequestMarshaller"> <summary> ListProjects Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListProjectsResponseUnmarshaller"> <summary> Response Unmarshaller for ListProjects operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListRunsRequestMarshaller"> <summary> ListRuns Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListRunsResponseUnmarshaller"> <summary> Response Unmarshaller for ListRuns operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListSamplesRequestMarshaller"> <summary> ListSamples Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListSamplesResponseUnmarshaller"> <summary> Response Unmarshaller for ListSamples operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListSuitesRequestMarshaller"> <summary> ListSuites Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListSuitesResponseUnmarshaller"> <summary> Response Unmarshaller for ListSuites operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListTestsRequestMarshaller"> <summary> ListTests Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListTestsResponseUnmarshaller"> <summary> Response Unmarshaller for ListTests operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListUniqueProblemsRequestMarshaller"> <summary> ListUniqueProblems Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListUniqueProblemsResponseUnmarshaller"> <summary> Response Unmarshaller for ListUniqueProblems operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListUploadsRequestMarshaller"> <summary> ListUploads Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ListUploadsResponseUnmarshaller"> <summary> Response Unmarshaller for ListUploads operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.LocationMarshaller"> <summary> Location Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ProblemDetailUnmarshaller"> <summary> Response Unmarshaller for ProblemDetail Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ProblemUnmarshaller"> <summary> Response Unmarshaller for Problem Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ProjectUnmarshaller"> <summary> Response Unmarshaller for Project Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.RadiosMarshaller"> <summary> Radios Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ResolutionUnmarshaller"> <summary> Response Unmarshaller for Resolution Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.RuleMarshaller"> <summary> Rule Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.RuleUnmarshaller"> <summary> Response Unmarshaller for Rule Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.RunUnmarshaller"> <summary> Response Unmarshaller for Run Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.SampleUnmarshaller"> <summary> Response Unmarshaller for Sample Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ScheduleRunConfigurationMarshaller"> <summary> ScheduleRunConfiguration Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ScheduleRunRequestMarshaller"> <summary> ScheduleRun Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ScheduleRunResponseUnmarshaller"> <summary> Response Unmarshaller for ScheduleRun operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.ScheduleRunTestMarshaller"> <summary> ScheduleRunTest Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.SuiteUnmarshaller"> <summary> Response Unmarshaller for Suite Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.TestUnmarshaller"> <summary> Response Unmarshaller for Test Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UniqueProblemUnmarshaller"> <summary> Response Unmarshaller for UniqueProblem Object </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UpdateDevicePoolRequestMarshaller"> <summary> UpdateDevicePool Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UpdateDevicePoolResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateDevicePool operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UpdateProjectRequestMarshaller"> <summary> UpdateProject Request Marshaller </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UpdateProjectResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateProject operation </summary> </member> <member name="T:Amazon.DeviceFarm.Model.Internal.MarshallTransformations.UploadUnmarshaller"> <summary> Response Unmarshaller for Upload Object </summary> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectClient"> <summary> Implementation for accessing DirectConnect AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections. <para> The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the <i>AWS Direct Connect API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all AWS Direct Connect actions.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Types.html">Data Types</a>: An alphabetical list of all AWS Direct Connect data types.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.html">Common Query Parameters</a>: Parameters that all Query actions can use.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonErrors.html">Common Errors</a>: Client and server errors that all actions can return.</li> </ul> </summary> </member> <member name="T:Amazon.DirectConnect.IAmazonDirectConnect"> <summary> Interface for accessing DirectConnect AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections. <para> The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the <i>AWS Direct Connect API Reference</i>: </para> <ul> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all AWS Direct Connect actions.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/API_Types.html">Data Types</a>: An alphabetical list of all AWS Direct Connect data types.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonParameters.html">Common Query Parameters</a>: Parameters that all Query actions can use.</li> <li><a href="http://docs.aws.amazon.com/directconnect/latest/APIReference/CommonErrors.html">Common Errors</a>: Client and server errors that all actions can return.</li> </ul> </summary> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginAllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndAllocateConnectionOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocateConnectionOnInterconnect operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateConnectionOnInterconnect.</param> <returns>Returns a AllocateConnectionOnInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginAllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndAllocatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePrivateVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePrivateVirtualInterface.</param> <returns>Returns a AllocatePrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginAllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndAllocatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocatePublicVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePublicVirtualInterface.</param> <returns>Returns a AllocatePublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection service method.</param> <returns>The response from the ConfirmConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndConfirmConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmConnection.</param> <returns>Returns a ConfirmConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndConfirmPrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPrivateVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPrivateVirtualInterface.</param> <returns>Returns a ConfirmPrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndConfirmPublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmPublicVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPublicVirtualInterface.</param> <returns>Returns a ConfirmPublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection service method.</param> <returns>The response from the CreateConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginCreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndCreateConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConnection.</param> <returns>Returns a CreateConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para> <para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect service method.</param> <returns>The response from the CreateInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginCreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndCreateInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInterconnect operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInterconnect.</param> <returns>Returns a CreateInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginCreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndCreatePrivateVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePrivateVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePrivateVirtualInterface.</param> <returns>Returns a CreatePrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginCreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndCreatePublicVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePublicVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePublicVirtualInterface.</param> <returns>Returns a CreatePublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection service method.</param> <returns>The response from the DeleteConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDeleteConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConnection.</param> <returns>Returns a DeleteConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> Deletes the specified interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect service method.</param> <returns>The response from the DeleteInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDeleteInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInterconnect operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInterconnect.</param> <returns>Returns a DeleteInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> Deletes a virtual interface. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface service method.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDeleteVirtualInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVirtualInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualInterface.</param> <returns>Returns a DeleteVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnections"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections service method.</param> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnections operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnections.</param> <returns>Returns a DescribeConnectionsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> Return a list of connections that have been provisioned on the given interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeConnectionsOnInterconnect(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConnectionsOnInterconnect operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnectionsOnInterconnect.</param> <returns>Returns a DescribeConnectionsOnInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeInterconnects"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects service method.</param> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeInterconnects(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInterconnects operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInterconnects.</param> <returns>Returns a DescribeInterconnectsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeLocations"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations service method.</param> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeLocations(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLocations operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLocations.</param> <returns>Returns a DescribeLocationsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualGateways"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways service method.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeVirtualGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualGateways.</param> <returns>Returns a DescribeVirtualGatewaysResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualInterfaces"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.IAmazonDirectConnect.BeginDescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDirectConnect.EndDescribeVirtualInterfaces(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVirtualInterfaces operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualInterfaces.</param> <returns>Returns a DescribeVirtualInterfacesResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Credentials and an AmazonDirectConnectClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.#ctor(System.String,System.String,System.String,Amazon.DirectConnect.AmazonDirectConnectConfig)"> <summary> Constructs AmazonDirectConnectClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectConnectClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDirectConnectClient Configuration Object</param> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest)"> <summary> Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect service method.</param> <returns>The response from the AllocateConnectionOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocateConnectionOnInterconnect(Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateConnectionOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateConnectionOnInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateConnectionOnInterconnect.</param> <returns>Returns a AllocateConnectionOnInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest)"> <summary> Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface service method.</param> <returns>The response from the AllocatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocatePrivateVirtualInterface(Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePrivateVirtualInterface.</param> <returns>Returns a AllocatePrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.AllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest)"> <summary> Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface service method.</param> <returns>The response from the AllocatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginAllocatePublicVirtualInterface(Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocatePublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocatePublicVirtualInterface.</param> <returns>Returns a AllocatePublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest)"> <summary> Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection service method.</param> <returns>The response from the ConfirmConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmConnection(Amazon.DirectConnect.Model.ConfirmConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmConnection.</param> <returns>Returns a ConfirmConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest)"> <summary> Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface service method.</param> <returns>The response from the ConfirmPrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmPrivateVirtualInterface(Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPrivateVirtualInterface.</param> <returns>Returns a ConfirmPrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.ConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest)"> <summary> Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface service method.</param> <returns>The response from the ConfirmPublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginConfirmPublicVirtualInterface(Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmPublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmPublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmPublicVirtualInterface.</param> <returns>Returns a ConfirmPublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest)"> <summary> Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection service method.</param> <returns>The response from the CreateConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreateConnection(Amazon.DirectConnect.Model.CreateConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateConnection.</param> <returns>Returns a CreateConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest)"> <summary> Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para> <para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect service method.</param> <returns>The response from the CreateInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreateInterconnect(Amazon.DirectConnect.Model.CreateInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInterconnect.</param> <returns>Returns a CreateInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest)"> <summary> Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface service method.</param> <returns>The response from the CreatePrivateVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreatePrivateVirtualInterface(Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePrivateVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePrivateVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePrivateVirtualInterface.</param> <returns>Returns a CreatePrivateVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.CreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest)"> <summary> Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface service method.</param> <returns>The response from the CreatePublicVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginCreatePublicVirtualInterface(Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePublicVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePublicVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePublicVirtualInterface.</param> <returns>Returns a CreatePublicVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest)"> <summary> Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection service method.</param> <returns>The response from the DeleteConnection service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteConnection(Amazon.DirectConnect.Model.DeleteConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteConnection operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteConnection.</param> <returns>Returns a DeleteConnectionResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest)"> <summary> Deletes the specified interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect service method.</param> <returns>The response from the DeleteInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteInterconnect(Amazon.DirectConnect.Model.DeleteInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInterconnect.</param> <returns>Returns a DeleteInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest)"> <summary> Deletes a virtual interface. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface service method.</param> <returns>The response from the DeleteVirtualInterface service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDeleteVirtualInterface(Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVirtualInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVirtualInterface operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVirtualInterface.</param> <returns>Returns a DeleteVirtualInterfaceResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest)"> <summary> Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections service method.</param> <returns>The response from the DescribeConnections service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeConnections(Amazon.DirectConnect.Model.DescribeConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnections operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnections.</param> <returns>Returns a DescribeConnectionsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest)"> <summary> Return a list of connections that have been provisioned on the given interconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect service method.</param> <returns>The response from the DescribeConnectionsOnInterconnect service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeConnectionsOnInterconnect(Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConnectionsOnInterconnect operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConnectionsOnInterconnect operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConnectionsOnInterconnect.</param> <returns>Returns a DescribeConnectionsOnInterconnectResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest)"> <summary> Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects service method.</param> <returns>The response from the DescribeInterconnects service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeInterconnects(Amazon.DirectConnect.Model.DescribeInterconnectsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInterconnects operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInterconnects operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInterconnects.</param> <returns>Returns a DescribeInterconnectsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest)"> <summary> Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations service method.</param> <returns>The response from the DescribeLocations service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeLocations(Amazon.DirectConnect.Model.DescribeLocationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLocations operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLocations operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLocations.</param> <returns>Returns a DescribeLocationsResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest)"> <summary> Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways service method.</param> <returns>The response from the DescribeVirtualGateways service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeVirtualGateways(Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualGateways operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualGateways.</param> <returns>Returns a DescribeVirtualGatewaysResult from DirectConnect.</returns> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.DescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest)"> <summary> Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces service method.</param> <returns>The response from the DescribeVirtualInterfaces service method, as returned by DirectConnect.</returns> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectClientException"> The API was called with invalid parameters. The error message will contain additional details about the cause. </exception> <exception cref="T:Amazon.DirectConnect.Model.DirectConnectServerException"> A server-side error occurred during the API call. The error message will contain additional details about the cause. </exception> </member> <member name="M:Amazon.DirectConnect.AmazonDirectConnectClient.BeginDescribeVirtualInterfaces(Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVirtualInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVirtualInterfaces operation on AmazonDirectConnectClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVirtualInterfaces.</param> <returns>Returns a DescribeVirtualInterfacesResult from DirectConnect.</returns> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectConfig"> <summary> Configuration for accessing Amazon DirectConnect 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.ConnectionState"> <summary> Constants used for properties of type ConnectionState. </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Available"> <summary> Constant Available for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Deleted"> <summary> Constant Deleted for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Deleting"> <summary> Constant Deleting for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Down"> <summary> Constant Down for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Ordering"> <summary> Constant Ordering for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Pending"> <summary> Constant Pending for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Rejected"> <summary> Constant Rejected for ConnectionState </summary> </member> <member name="F:Amazon.DirectConnect.ConnectionState.Requested"> <summary> Constant Requested for ConnectionState </summary> </member> <member name="M:Amazon.DirectConnect.ConnectionState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectConnect.ConnectionState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectConnect.InterconnectState"> <summary> Constants used for properties of type InterconnectState. </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Available"> <summary> Constant Available for InterconnectState </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Deleted"> <summary> Constant Deleted for InterconnectState </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Deleting"> <summary> Constant Deleting for InterconnectState </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Down"> <summary> Constant Down for InterconnectState </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Pending"> <summary> Constant Pending for InterconnectState </summary> </member> <member name="F:Amazon.DirectConnect.InterconnectState.Requested"> <summary> Constant Requested for InterconnectState </summary> </member> <member name="M:Amazon.DirectConnect.InterconnectState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectConnect.InterconnectState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectConnect.VirtualInterfaceState"> <summary> Constants used for properties of type VirtualInterfaceState. </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Available"> <summary> Constant Available for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Confirming"> <summary> Constant Confirming for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Deleted"> <summary> Constant Deleted for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Deleting"> <summary> Constant Deleting for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Pending"> <summary> Constant Pending for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Rejected"> <summary> Constant Rejected for VirtualInterfaceState </summary> </member> <member name="F:Amazon.DirectConnect.VirtualInterfaceState.Verifying"> <summary> Constant Verifying for VirtualInterfaceState </summary> </member> <member name="M:Amazon.DirectConnect.VirtualInterfaceState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectConnect.VirtualInterfaceState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest"> <summary> Container for the parameters to the AllocateConnectionOnInterconnect operation. Creates a hosted connection on an interconnect. <para> Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect. </para> </summary> </member> <member name="T:Amazon.DirectConnect.AmazonDirectConnectRequest"> <summary> Base class for DirectConnect operation requests. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> Bandwidth of the connection. </para> <para> Example: "<i>500Mbps</i>" </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.ConnectionName"> <summary> Gets and sets the property ConnectionName. <para> Name of the provisioned connection. </para> <para> Example: "<i>500M Connection to AWS</i>" </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.InterconnectId"> <summary> Gets and sets the property InterconnectId. <para> ID of the interconnect on which the connection will be provisioned. </para> <para> Example: dxcon-456abc78 </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. <para> Numeric account Id of the customer for whom the connection will be provisioned. </para> <para> Example: 123443215678 </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectRequest.Vlan"> <summary> Gets and sets the property Vlan. <para> The dedicated VLAN provisioned to the connection. </para> <para> Example: 101 </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResponse"> <summary> Configuration for accessing Amazon AllocateConnectionOnInterconnect service </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult"> <summary> A connection represents the physical network connection between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> Bandwidth of the connection. </para> <para> Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections) </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionName"> <summary> Gets and sets the property ConnectionName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.ConnectionState"> <summary> Gets and sets the property ConnectionState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.PartnerName"> <summary> Gets and sets the property PartnerName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocateConnectionOnInterconnectResponse.AllocateConnectionOnInterconnectResult"> <summary> Gets and sets the AllocateConnectionOnInterconnectResult property. Represents the output of a AllocateConnectionOnInterconnect operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the AllocatePrivateVirtualInterface operation. Provisions a private virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. <para> The connection ID on which the private virtual interface is provisioned. </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.NewPrivateVirtualInterfaceAllocation"> <summary> Gets and sets the property NewPrivateVirtualInterfaceAllocation. <para> Detailed information for the private virtual interface to be provisioned. </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceRequest.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. <para> The AWS account that will own the new private virtual interface. </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon AllocatePrivateVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult"> <summary> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.CustomerRouterConfig"> <summary> Gets and sets the property CustomerRouterConfig. <para> Information for generating the customer router configuration. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.VirtualInterfaceType"> <summary> Gets and sets the property VirtualInterfaceType. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePrivateVirtualInterfaceResponse.AllocatePrivateVirtualInterfaceResult"> <summary> Gets and sets the AllocatePrivateVirtualInterfaceResult property. Represents the output of a AllocatePrivateVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest"> <summary> Container for the parameters to the AllocatePublicVirtualInterface operation. Provisions a public virtual interface to be owned by a different customer. <para> The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer. </para> <para> Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. <para> The connection ID on which the public virtual interface is provisioned. </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.NewPublicVirtualInterfaceAllocation"> <summary> Gets and sets the property NewPublicVirtualInterfaceAllocation. <para> Detailed information for the public virtual interface to be provisioned. </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceRequest.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. <para> The AWS account that will own the new public virtual interface. </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon AllocatePublicVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult"> <summary> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.CustomerRouterConfig"> <summary> Gets and sets the property CustomerRouterConfig. <para> Information for generating the customer router configuration. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.VirtualInterfaceType"> <summary> Gets and sets the property VirtualInterfaceType. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.AllocatePublicVirtualInterfaceResponse.AllocatePublicVirtualInterfaceResult"> <summary> Gets and sets the AllocatePublicVirtualInterfaceResult property. Represents the output of a AllocatePublicVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionRequest"> <summary> Container for the parameters to the ConfirmConnection operation. Confirm the creation of a hosted connection on an interconnect. <para> Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionResponse"> <summary> Configuration for accessing Amazon ConfirmConnection service </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmConnectionResult"> <summary> The response received when ConfirmConnection is called. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionResult.ConnectionState"> <summary> Gets and sets the property ConnectionState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmConnectionResponse.ConfirmConnectionResult"> <summary> Gets and sets the ConfirmConnectionResult property. Represents the output of a ConfirmConnection operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the ConfirmPrivateVirtualInterface operation. Accept ownership of a private virtual interface created by another customer. <para> After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. <para> ID of the virtual private gateway that will be attached to the virtual interface. </para> <para> 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. </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceRequest.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon ConfirmPrivateVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResult"> <summary> The response received when ConfirmPrivateVirtualInterface is called. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPrivateVirtualInterfaceResponse.ConfirmPrivateVirtualInterfaceResult"> <summary> Gets and sets the ConfirmPrivateVirtualInterfaceResult property. Represents the output of a ConfirmPrivateVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest"> <summary> Container for the parameters to the ConfirmPublicVirtualInterface operation. Accept ownership of a public virtual interface created by another customer. <para> After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceRequest.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon ConfirmPublicVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResult"> <summary> The response received when ConfirmPublicVirtualInterface is called. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.ConfirmPublicVirtualInterfaceResponse.ConfirmPublicVirtualInterfaceResult"> <summary> Gets and sets the ConfirmPublicVirtualInterfaceResult property. Represents the output of a ConfirmPublicVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.Connection"> <summary> A connection represents the physical network connection between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> Bandwidth of the connection. </para> <para> Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections) </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionName"> <summary> Gets and sets the property ConnectionName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.ConnectionState"> <summary> Gets and sets the property ConnectionState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.PartnerName"> <summary> Gets and sets the property PartnerName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Connection.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionRequest"> <summary> Container for the parameters to the CreateConnection operation. Creates a new connection between the customer network and a specific AWS Direct Connect location. <para> A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.Bandwidth"> <summary> Gets and sets the property Bandwidth. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.ConnectionName"> <summary> Gets and sets the property ConnectionName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionRequest.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionResponse"> <summary> Configuration for accessing Amazon CreateConnection service </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateConnectionResult"> <summary> A connection represents the physical network connection between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> Bandwidth of the connection. </para> <para> Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections) </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionName"> <summary> Gets and sets the property ConnectionName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.ConnectionState"> <summary> Gets and sets the property ConnectionState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.PartnerName"> <summary> Gets and sets the property PartnerName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateConnectionResponse.CreateConnectionResult"> <summary> Gets and sets the CreateConnectionResult property. Represents the output of a CreateConnection operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectRequest"> <summary> Container for the parameters to the CreateInterconnect operation. Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location. <para> An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router. </para> <para> For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> The port bandwidth </para> <para> Example: 1Gbps </para> <para> Default: None </para> <para> Available values: 1Gbps,10Gbps </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.InterconnectName"> <summary> Gets and sets the property InterconnectName. <para> The name of the interconnect. </para> <para> Example: "<i>1G Interconnect to AWS</i>" </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectRequest.Location"> <summary> Gets and sets the property Location. <para> Where the interconnect is located </para> <para> Example: EqSV5 </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectResponse"> <summary> Configuration for accessing Amazon CreateInterconnect service </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreateInterconnectResult"> <summary> An interconnect is a connection that can host other connections. <para> Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS 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="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Bandwidth"> <summary> Gets and sets the property Bandwidth. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectId"> <summary> Gets and sets the property InterconnectId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectName"> <summary> Gets and sets the property InterconnectName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.InterconnectState"> <summary> Gets and sets the property InterconnectState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResult.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreateInterconnectResponse.CreateInterconnectResult"> <summary> Gets and sets the CreateInterconnectResult property. Represents the output of a CreateInterconnect operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest"> <summary> Container for the parameters to the CreatePrivateVirtualInterface operation. Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC). </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceRequest.NewPrivateVirtualInterface"> <summary> Gets and sets the property NewPrivateVirtualInterface. <para> Detailed information for the private virtual interface to be created. </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon CreatePrivateVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult"> <summary> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.CustomerRouterConfig"> <summary> Gets and sets the property CustomerRouterConfig. <para> Information for generating the customer router configuration. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.VirtualInterfaceType"> <summary> Gets and sets the property VirtualInterfaceType. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePrivateVirtualInterfaceResponse.CreatePrivateVirtualInterfaceResult"> <summary> Gets and sets the CreatePrivateVirtualInterfaceResult property. Represents the output of a CreatePrivateVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest"> <summary> Container for the parameters to the CreatePublicVirtualInterface operation. Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3). </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceRequest.NewPublicVirtualInterface"> <summary> Gets and sets the property NewPublicVirtualInterface. <para> Detailed information for the public virtual interface to be created. </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon CreatePublicVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult"> <summary> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.CustomerRouterConfig"> <summary> Gets and sets the property CustomerRouterConfig. <para> Information for generating the customer router configuration. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.VirtualInterfaceType"> <summary> Gets and sets the property VirtualInterfaceType. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.CreatePublicVirtualInterfaceResponse.CreatePublicVirtualInterfaceResult"> <summary> Gets and sets the CreatePublicVirtualInterfaceResult property. Represents the output of a CreatePublicVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionRequest"> <summary> Container for the parameters to the DeleteConnection operation. Deletes the connection. <para> Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionResponse"> <summary> Configuration for accessing Amazon DeleteConnection service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteConnectionResult"> <summary> A connection represents the physical network connection between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Bandwidth"> <summary> Gets and sets the property Bandwidth. <para> Bandwidth of the connection. </para> <para> Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections) </para> <para> Default: None </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionName"> <summary> Gets and sets the property ConnectionName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.ConnectionState"> <summary> Gets and sets the property ConnectionState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.PartnerName"> <summary> Gets and sets the property PartnerName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResult.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteConnectionResponse.DeleteConnectionResult"> <summary> Gets and sets the DeleteConnectionResult property. Represents the output of a DeleteConnection operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectRequest"> <summary> Container for the parameters to the DeleteInterconnect operation. Deletes the specified interconnect. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectRequest.InterconnectId"> <summary> Gets and sets the property InterconnectId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectResponse"> <summary> Configuration for accessing Amazon DeleteInterconnect service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteInterconnectResult"> <summary> The response received when DeleteInterconnect is called. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectResult.InterconnectState"> <summary> Gets and sets the property InterconnectState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteInterconnectResponse.DeleteInterconnectResult"> <summary> Gets and sets the DeleteInterconnectResult property. Represents the output of a DeleteInterconnect operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest"> <summary> Container for the parameters to the DeleteVirtualInterface operation. Deletes a virtual interface. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceRequest.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResponse"> <summary> Configuration for accessing Amazon DeleteVirtualInterface service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResult"> <summary> The response received when DeleteVirtualInterface is called. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResult.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DeleteVirtualInterfaceResponse.DeleteVirtualInterfaceResult"> <summary> Gets and sets the DeleteVirtualInterfaceResult property. Represents the output of a DeleteVirtualInterface operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest"> <summary> Container for the parameters to the DescribeConnectionsOnInterconnect operation. Return a list of connections that have been provisioned on the given interconnect. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectRequest.InterconnectId"> <summary> Gets and sets the property InterconnectId. <para> ID of the interconnect on which a list of connection is provisioned. </para> <para> Example: dxcon-abc123 </para> <para> Default: None </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResponse"> <summary> Configuration for accessing Amazon DescribeConnectionsOnInterconnect service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult"> <summary> A structure containing a list of connections. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResult.Connections"> <summary> Gets and sets the property Connections. <para> A list of connections. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsOnInterconnectResponse.DescribeConnectionsOnInterconnectResult"> <summary> Gets and sets the DescribeConnectionsOnInterconnectResult property. Represents the output of a DescribeConnectionsOnInterconnect operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsRequest"> <summary> Container for the parameters to the DescribeConnections operation. Displays all connections in this region. <para> If a connection ID is provided, the call returns only that particular connection. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsResponse"> <summary> Configuration for accessing Amazon DescribeConnections service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeConnectionsResult"> <summary> A structure containing a list of connections. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsResult.Connections"> <summary> Gets and sets the property Connections. <para> A list of connections. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeConnectionsResponse.DescribeConnectionsResult"> <summary> Gets and sets the DescribeConnectionsResult property. Represents the output of a DescribeConnections operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsRequest"> <summary> Container for the parameters to the DescribeInterconnects operation. Returns a list of interconnects owned by the AWS account. <para> If an interconnect ID is provided, it will only return this particular interconnect. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsRequest.InterconnectId"> <summary> Gets and sets the property InterconnectId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsResponse"> <summary> Configuration for accessing Amazon DescribeInterconnects service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeInterconnectsResult"> <summary> A structure containing a list of interconnects. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsResult.Interconnects"> <summary> Gets and sets the property Interconnects. <para> A list of interconnects. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeInterconnectsResponse.DescribeInterconnectsResult"> <summary> Gets and sets the DescribeInterconnectsResult property. Represents the output of a DescribeInterconnects operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsRequest"> <summary> Container for the parameters to the DescribeLocations operation. Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsResponse"> <summary> Configuration for accessing Amazon DescribeLocations service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeLocationsResult"> <summary> A location is a network facility where AWS Direct Connect routers are available to be connected. Generally, these are colocation hubs where many network providers have equipment, and where cross connects can be delivered. Locations include a name and facility code, and must be provided when creating a connection. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeLocationsResult.Locations"> <summary> Gets and sets the property Locations. <para> A list of colocation hubs where network providers have equipment. Most regions have multiple locations available. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeLocationsResponse.DescribeLocationsResult"> <summary> Gets and sets the DescribeLocationsResult property. Represents the output of a DescribeLocations operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysRequest"> <summary> Container for the parameters to the DescribeVirtualGateways operation. Returns a list of virtual private gateways owned by the AWS account. <para> You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">EC2 CreateVpnGateway</a> action. </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResponse"> <summary> Configuration for accessing Amazon DescribeVirtualGateways service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult"> <summary> A structure containing a list of virtual private gateways. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResult.VirtualGateways"> <summary> Gets and sets the property VirtualGateways. <para> A list of virtual private gateways. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualGatewaysResponse.DescribeVirtualGatewaysResult"> <summary> Gets and sets the DescribeVirtualGatewaysResult property. Represents the output of a DescribeVirtualGateways operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest"> <summary> Container for the parameters to the DescribeVirtualInterfaces operation. Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned. <para> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </para> <para> If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesRequest.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResponse"> <summary> Configuration for accessing Amazon DescribeVirtualInterfaces service </summary> </member> <member name="T:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult"> <summary> A structure containing a list of virtual interfaces. </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResult.VirtualInterfaces"> <summary> Gets and sets the property VirtualInterfaces. <para> A list of virtual interfaces. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.DescribeVirtualInterfacesResponse.DescribeVirtualInterfacesResult"> <summary> Gets and sets the DescribeVirtualInterfacesResult property. Represents the output of a DescribeVirtualInterfaces operation. </summary> </member> <member name="T:Amazon.DirectConnect.Model.DirectConnectClientException"> <summary> DirectConnect 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> DirectConnect 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> An interconnect is a connection that can host other connections. <para> Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS 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="P:Amazon.DirectConnect.Model.Interconnect.Bandwidth"> <summary> Gets and sets the property Bandwidth. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectId"> <summary> Gets and sets the property InterconnectId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectName"> <summary> Gets and sets the property InterconnectName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.InterconnectState"> <summary> Gets and sets the property InterconnectState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Interconnect.Region"> <summary> Gets and sets the property Region. </summary> </member> <member name="T:Amazon.DirectConnect.Model.Location"> <summary> An AWS Direct Connect location where connections and interconnects can be requested. </summary> </member> <member name="P:Amazon.DirectConnect.Model.Location.LocationCode"> <summary> Gets and sets the property LocationCode. <para> The code used to indicate the AWS Direct Connect location. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.Location.LocationName"> <summary> Gets and sets the property LocationName. <para> The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building. </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPrivateVirtualInterface"> <summary> A structure containing information about a new private virtual interface. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterface.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation"> <summary> A structure containing information about a private virtual interface that will be provisioned on a connection. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPrivateVirtualInterfaceAllocation.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPublicVirtualInterface"> <summary> A structure containing information about a new public virtual interface. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterface.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation"> <summary> A structure containing information about a public virtual interface that will be provisioned on a connection. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.NewPublicVirtualInterfaceAllocation.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.RouteFilterPrefix"> <summary> A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface. </summary> </member> <member name="P:Amazon.DirectConnect.Model.RouteFilterPrefix.Cidr"> <summary> Gets and sets the property Cidr. <para> CIDR notation for the advertised route. Multiple routes are separated by commas. </para> <para> Example: 10.10.10.0/24,10.10.11.0/24 </para> </summary> </member> <member name="T:Amazon.DirectConnect.Model.VirtualGateway"> <summary> You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway. <para> Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html">Amazon EC2 CreateVpnGateway action</a>. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualGateway.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualGateway.VirtualGatewayState"> <summary> Gets and sets the property VirtualGatewayState. </summary> </member> <member name="T:Amazon.DirectConnect.Model.VirtualInterface"> <summary> A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.AmazonAddress"> <summary> Gets and sets the property AmazonAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Asn"> <summary> Gets and sets the property Asn. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.AuthKey"> <summary> Gets and sets the property AuthKey. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.ConnectionId"> <summary> Gets and sets the property ConnectionId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.CustomerAddress"> <summary> Gets and sets the property CustomerAddress. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.CustomerRouterConfig"> <summary> Gets and sets the property CustomerRouterConfig. <para> Information for generating the customer router configuration. </para> </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Location"> <summary> Gets and sets the property Location. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.OwnerAccount"> <summary> Gets and sets the property OwnerAccount. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.RouteFilterPrefixes"> <summary> Gets and sets the property RouteFilterPrefixes. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualGatewayId"> <summary> Gets and sets the property VirtualGatewayId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceId"> <summary> Gets and sets the property VirtualInterfaceId. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceName"> <summary> Gets and sets the property VirtualInterfaceName. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceState"> <summary> Gets and sets the property VirtualInterfaceState. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.VirtualInterfaceType"> <summary> Gets and sets the property VirtualInterfaceType. </summary> </member> <member name="P:Amazon.DirectConnect.Model.VirtualInterface.Vlan"> <summary> Gets and sets the property Vlan. </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.AllocateConnectionOnInterconnectRequestMarshaller"> <summary> AllocateConnectionOnInterconnect 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.AllocatePrivateVirtualInterfaceRequestMarshaller"> <summary> AllocatePrivateVirtualInterface 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.AllocatePublicVirtualInterfaceRequestMarshaller"> <summary> AllocatePublicVirtualInterface 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.ConfirmConnectionRequestMarshaller"> <summary> ConfirmConnection 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.ConfirmPrivateVirtualInterfaceRequestMarshaller"> <summary> ConfirmPrivateVirtualInterface 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.ConfirmPublicVirtualInterfaceRequestMarshaller"> <summary> ConfirmPublicVirtualInterface 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.ConnectionUnmarshaller"> <summary> Response Unmarshaller for Connection Object </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.CreateConnectionRequestMarshaller"> <summary> CreateConnection 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.CreateInterconnectRequestMarshaller"> <summary> CreateInterconnect 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.CreatePrivateVirtualInterfaceRequestMarshaller"> <summary> CreatePrivateVirtualInterface 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.CreatePublicVirtualInterfaceRequestMarshaller"> <summary> CreatePublicVirtualInterface 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.DeleteConnectionRequestMarshaller"> <summary> DeleteConnection 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.DeleteInterconnectRequestMarshaller"> <summary> DeleteInterconnect 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.DeleteVirtualInterfaceRequestMarshaller"> <summary> DeleteVirtualInterface 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.DescribeConnectionsOnInterconnectRequestMarshaller"> <summary> DescribeConnectionsOnInterconnect 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.DescribeConnectionsRequestMarshaller"> <summary> DescribeConnections 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.DescribeInterconnectsRequestMarshaller"> <summary> DescribeInterconnects 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.DescribeLocationsRequestMarshaller"> <summary> DescribeLocations 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.DescribeVirtualGatewaysRequestMarshaller"> <summary> DescribeVirtualGateways 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.DescribeVirtualInterfacesRequestMarshaller"> <summary> DescribeVirtualInterfaces 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.InterconnectUnmarshaller"> <summary> Response Unmarshaller for Interconnect Object </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.LocationUnmarshaller"> <summary> Response Unmarshaller for Location Object </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.NewPrivateVirtualInterfaceAllocationMarshaller"> <summary> NewPrivateVirtualInterfaceAllocation Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.NewPrivateVirtualInterfaceMarshaller"> <summary> NewPrivateVirtualInterface Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.NewPublicVirtualInterfaceAllocationMarshaller"> <summary> NewPublicVirtualInterfaceAllocation Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.NewPublicVirtualInterfaceMarshaller"> <summary> NewPublicVirtualInterface Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.RouteFilterPrefixMarshaller"> <summary> RouteFilterPrefix Marshaller </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.RouteFilterPrefixUnmarshaller"> <summary> Response Unmarshaller for RouteFilterPrefix Object </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.VirtualGatewayUnmarshaller"> <summary> Response Unmarshaller for VirtualGateway Object </summary> </member> <member name="T:Amazon.DirectConnect.Model.Internal.MarshallTransformations.VirtualInterfaceUnmarshaller"> <summary> Response Unmarshaller for VirtualInterface Object </summary> </member> <member name="T:Amazon.DirectoryService.AmazonDirectoryServiceClient"> <summary> Implementation for accessing DirectoryService AWS Directory Service <para> This is the <i>AWS Directory Service API Reference</i>. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. </para> </summary> </member> <member name="T:Amazon.DirectoryService.IAmazonDirectoryService"> <summary> Interface for accessing DirectoryService AWS Directory Service <para> This is the <i>AWS Directory Service API Reference</i>. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. </para> </summary> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.ConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest)"> <summary> Creates an AD Connector to connect to an on-premises directory. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory service method.</param> <returns>The response from the ConnectDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConnectDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConnectDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndConnectDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConnectDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConnectDirectory.</param> <returns>Returns a ConnectDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest)"> <summary> Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. <important> <para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAlias operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndCreateAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAlias operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAlias.</param> <returns>Returns a CreateAliasResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest)"> <summary> Creates a computer account in the specified directory, and joins the computer to the directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer service method.</param> <returns>The response from the CreateComputer service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryUnavailableException"> The specified directory is unavailable or could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateComputer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateComputer operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndCreateComputer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateComputer operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateComputer.</param> <returns>Returns a CreateComputerResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest)"> <summary> Creates a Simple AD directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory service method.</param> <returns>The response from the CreateDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndCreateDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDirectory.</param> <returns>Returns a CreateDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest)"> <summary> Creates a Microsoft AD in the AWS cloud. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD service method.</param> <returns>The response from the CreateMicrosoftAD service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateMicrosoftAD operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndCreateMicrosoftAD(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateMicrosoftAD.</param> <returns>Returns a CreateMicrosoftADResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. <note> <para> You cannot take snapshots of AD Connector directories. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.SnapshotLimitExceededException"> The maximum number of manual snapshots for the directory has been reached. You can use the <a>GetSnapshotLimits</a> operation to determine the snapshot limits for a directory. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.IAmazonDirectoryService.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a CreateSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.CreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. <para> This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust service method.</param> <returns>The response from the CreateTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginCreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndCreateTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrust.</param> <returns>Returns a CreateTrustResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest)"> <summary> Deletes an AWS Directory Service directory. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory service method.</param> <returns>The response from the DeleteDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDeleteDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDirectory.</param> <returns>Returns a DeleteDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest)"> <summary> Deletes a directory snapshot. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.IAmazonDirectoryService.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a DeleteSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest)"> <summary> Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust service method.</param> <returns>The response from the DeleteTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDeleteTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrust.</param> <returns>Returns a DeleteTrustResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest)"> <summary> Removes the specified directory as a publisher to the specified SNS topic. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic service method.</param> <returns>The response from the DeregisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterEventTopic operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDeregisterEventTopic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterEventTopic.</param> <returns>Returns a DeregisterEventTopicResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeDirectories"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest)"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories service method.</param> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDirectories operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDescribeDirectories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDirectories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDirectories.</param> <returns>Returns a DescribeDirectoriesResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest)"> <summary> Obtains information about which SNS topics receive status messages from the specified directory. <para> If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics service method.</param> <returns>The response from the DescribeEventTopics service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEventTopics operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDescribeEventTopics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEventTopics.</param> <returns>Returns a DescribeEventTopicsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest)"> <summary> Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.IAmazonDirectoryService.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest)"> <summary> Obtains information about the trust relationships for this account. <para> If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts service method.</param> <returns>The response from the DescribeTrusts service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrusts operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrusts operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDescribeTrusts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrusts operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrusts.</param> <returns>Returns a DescribeTrustsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest)"> <summary> Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius service method.</param> <returns>The response from the DisableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDisableRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableRadius.</param> <returns>Returns a DisableRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.DisableSso(Amazon.DirectoryService.Model.DisableSsoRequest)"> <summary> Disables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso service method.</param> <returns>The response from the DisableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginDisableSso(Amazon.DirectoryService.Model.DisableSsoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableSso operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndDisableSso(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableSso operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableSso.</param> <returns>Returns a DisableSsoResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest)"> <summary> Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius service method.</param> <returns>The response from the EnableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginEnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndEnableRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableRadius.</param> <returns>Returns a EnableRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EnableSso(Amazon.DirectoryService.Model.EnableSsoRequest)"> <summary> Enables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso service method.</param> <returns>The response from the EnableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginEnableSso(Amazon.DirectoryService.Model.EnableSsoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableSso operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndEnableSso(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableSso operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableSso.</param> <returns>Returns a EnableSsoResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetDirectoryLimits"> <summary> Obtains directory limit information for the current region. </summary> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest)"> <summary> Obtains directory limit information for the current region. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits service method.</param> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginGetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDirectoryLimits operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndGetDirectoryLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDirectoryLimits.</param> <returns>Returns a GetDirectoryLimitsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.GetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest)"> <summary> Obtains the manual snapshot limits for a directory. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits service method.</param> <returns>The response from the GetSnapshotLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginGetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSnapshotLimits operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndGetSnapshotLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSnapshotLimits.</param> <returns>Returns a GetSnapshotLimitsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest)"> <summary> Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic service method.</param> <returns>The response from the RegisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginRegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterEventTopic operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndRegisterEventTopic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterEventTopic.</param> <returns>Returns a RegisterEventTopicResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.RestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest)"> <summary> Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para> <para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot service method.</param> <returns>The response from the RestoreFromSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginRestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreFromSnapshot operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndRestoreFromSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreFromSnapshot.</param> <returns>Returns a RestoreFromSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.UpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest)"> <summary> Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius service method.</param> <returns>The response from the UpdateRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginUpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndUpdateRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRadius.</param> <returns>Returns a UpdateRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.VerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. <para> This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust service method.</param> <returns>The response from the VerifyTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.BeginVerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the VerifyTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndVerifyTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.IAmazonDirectoryService.EndVerifyTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the VerifyTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginVerifyTrust.</param> <returns>Returns a VerifyTrustResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Credentials and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.#ctor(System.String,System.String,System.String,Amazon.DirectoryService.AmazonDirectoryServiceConfig)"> <summary> Constructs AmazonDirectoryServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonDirectoryServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDirectoryServiceClient Configuration Object</param> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.ConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest)"> <summary> Creates an AD Connector to connect to an on-premises directory. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory service method.</param> <returns>The response from the ConnectDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginConnectDirectory(Amazon.DirectoryService.Model.ConnectDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConnectDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the ConnectDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConnectDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndConnectDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConnectDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConnectDirectory.</param> <returns>Returns a ConnectDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest)"> <summary> Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. <important> <para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias service method.</param> <returns>The response from the CreateAlias service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateAlias(Amazon.DirectoryService.Model.CreateAliasRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateAlias operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateAlias operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateAlias operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndCreateAlias(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateAlias operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateAlias.</param> <returns>Returns a CreateAliasResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest)"> <summary> Creates a computer account in the specified directory, and joins the computer to the directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer service method.</param> <returns>The response from the CreateComputer service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryUnavailableException"> The specified directory is unavailable or could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateComputer(Amazon.DirectoryService.Model.CreateComputerRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateComputer operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateComputer operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateComputer operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndCreateComputer(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateComputer operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateComputer.</param> <returns>Returns a CreateComputerResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest)"> <summary> Creates a Simple AD directory. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory service method.</param> <returns>The response from the CreateDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateDirectory(Amazon.DirectoryService.Model.CreateDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndCreateDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDirectory.</param> <returns>Returns a CreateDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest)"> <summary> Creates a Microsoft AD in the AWS cloud. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD service method.</param> <returns>The response from the CreateMicrosoftAD service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateMicrosoftAD(Amazon.DirectoryService.Model.CreateMicrosoftADRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateMicrosoftAD operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateMicrosoftAD operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndCreateMicrosoftAD(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateMicrosoftAD operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateMicrosoftAD.</param> <returns>Returns a CreateMicrosoftADResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. <note> <para> You cannot take snapshots of AD Connector directories. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.SnapshotLimitExceededException"> The maximum number of manual snapshots for the directory has been reached. You can use the <a>GetSnapshotLimits</a> operation to determine the snapshot limits for a directory. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateSnapshot(Amazon.DirectoryService.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.AmazonDirectoryServiceClient.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a CreateSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.CreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. <para> This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust service method.</param> <returns>The response from the CreateTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginCreateTrust(Amazon.DirectoryService.Model.CreateTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndCreateTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTrust.</param> <returns>Returns a CreateTrustResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest)"> <summary> Deletes an AWS Directory Service directory. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory service method.</param> <returns>The response from the DeleteDirectory service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDeleteDirectory(Amazon.DirectoryService.Model.DeleteDirectoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDirectory operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDirectory operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDirectory operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDeleteDirectory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDirectory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDirectory.</param> <returns>Returns a DeleteDirectoryResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest)"> <summary> Deletes a directory snapshot. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDeleteSnapshot(Amazon.DirectoryService.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.AmazonDirectoryServiceClient.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a DeleteSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest)"> <summary> Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust service method.</param> <returns>The response from the DeleteTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDeleteTrust(Amazon.DirectoryService.Model.DeleteTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDeleteTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTrust.</param> <returns>Returns a DeleteTrustResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest)"> <summary> Removes the specified directory as a publisher to the specified SNS topic. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic service method.</param> <returns>The response from the DeregisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDeregisterEventTopic(Amazon.DirectoryService.Model.DeregisterEventTopicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterEventTopic operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterEventTopic operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDeregisterEventTopic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterEventTopic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterEventTopic.</param> <returns>Returns a DeregisterEventTopicResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeDirectories"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest)"> <summary> Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories service method.</param> <returns>The response from the DescribeDirectories service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDescribeDirectories(Amazon.DirectoryService.Model.DescribeDirectoriesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDirectories operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDirectories operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDirectories operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDescribeDirectories(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDirectories operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDirectories.</param> <returns>Returns a DescribeDirectoriesResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest)"> <summary> Obtains information about which SNS topics receive status messages from the specified directory. <para> If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics service method.</param> <returns>The response from the DescribeEventTopics service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDescribeEventTopics(Amazon.DirectoryService.Model.DescribeEventTopicsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeEventTopics operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeEventTopics operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDescribeEventTopics(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeEventTopics operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeEventTopics.</param> <returns>Returns a DescribeEventTopicsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest)"> <summary> Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDescribeSnapshots(Amazon.DirectoryService.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.DirectoryService.AmazonDirectoryServiceClient.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest)"> <summary> Obtains information about the trust relationships for this account. <para> If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts service method.</param> <returns>The response from the DescribeTrusts service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> The <i>NextToken</i> value is not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDescribeTrusts(Amazon.DirectoryService.Model.DescribeTrustsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTrusts operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTrusts operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTrusts operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDescribeTrusts(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTrusts operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTrusts.</param> <returns>Returns a DescribeTrustsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest)"> <summary> Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius service method.</param> <returns>The response from the DisableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDisableRadius(Amazon.DirectoryService.Model.DisableRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDisableRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableRadius.</param> <returns>Returns a DisableRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.DisableSso(Amazon.DirectoryService.Model.DisableSsoRequest)"> <summary> Disables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso service method.</param> <returns>The response from the DisableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginDisableSso(Amazon.DirectoryService.Model.DisableSsoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableSso operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableSso operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndDisableSso(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableSso operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableSso.</param> <returns>Returns a DisableSsoResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest)"> <summary> Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius service method.</param> <returns>The response from the EnableRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> The specified entity already exists. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginEnableRadius(Amazon.DirectoryService.Model.EnableRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndEnableRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableRadius.</param> <returns>Returns a EnableRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EnableSso(Amazon.DirectoryService.Model.EnableSsoRequest)"> <summary> Enables single-sign on for a directory. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso service method.</param> <returns>The response from the EnableSso service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> An authentication error occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> The account does not have sufficient permission to perform the operation. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginEnableSso(Amazon.DirectoryService.Model.EnableSsoRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableSso operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableSso operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableSso operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndEnableSso(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableSso operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableSso.</param> <returns>Returns a EnableSsoResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetDirectoryLimits"> <summary> Obtains directory limit information for the current region. </summary> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest)"> <summary> Obtains directory limit information for the current region. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits service method.</param> <returns>The response from the GetDirectoryLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginGetDirectoryLimits(Amazon.DirectoryService.Model.GetDirectoryLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetDirectoryLimits operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetDirectoryLimits operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndGetDirectoryLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetDirectoryLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetDirectoryLimits.</param> <returns>Returns a GetDirectoryLimitsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.GetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest)"> <summary> Obtains the manual snapshot limits for a directory. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits service method.</param> <returns>The response from the GetSnapshotLimits service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginGetSnapshotLimits(Amazon.DirectoryService.Model.GetSnapshotLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSnapshotLimits operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetSnapshotLimits operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndGetSnapshotLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetSnapshotLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetSnapshotLimits.</param> <returns>Returns a GetSnapshotLimitsResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest)"> <summary> Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic service method.</param> <returns>The response from the RegisterEventTopic service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginRegisterEventTopic(Amazon.DirectoryService.Model.RegisterEventTopicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterEventTopic operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterEventTopic operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndRegisterEventTopic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterEventTopic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterEventTopic.</param> <returns>Returns a RegisterEventTopicResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.RestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest)"> <summary> Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para> <para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot service method.</param> <returns>The response from the RestoreFromSnapshot service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginRestoreFromSnapshot(Amazon.DirectoryService.Model.RestoreFromSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreFromSnapshot operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreFromSnapshot operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndRestoreFromSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestoreFromSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreFromSnapshot.</param> <returns>Returns a RestoreFromSnapshotResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.UpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest)"> <summary> Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius service method.</param> <returns>The response from the UpdateRadius service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginUpdateRadius(Amazon.DirectoryService.Model.UpdateRadiusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateRadius operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateRadius operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateRadius operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndUpdateRadius(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateRadius operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateRadius.</param> <returns>Returns a UpdateRadiusResult from DirectoryService.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.VerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest)"> <summary> AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. <para> This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. </para> </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust service method.</param> <returns>The response from the VerifyTrust service method, as returned by DirectoryService.</returns> <exception cref="T:Amazon.DirectoryService.Model.ClientException"> A client exception has occurred. </exception> <exception cref="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> The specified entity could not be found. </exception> <exception cref="T:Amazon.DirectoryService.Model.InvalidParameterException"> One or more parameters are not valid. </exception> <exception cref="T:Amazon.DirectoryService.Model.ServiceException"> An exception has occurred in AWS Directory Service. </exception> <exception cref="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> The operation is not supported. </exception> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.BeginVerifyTrust(Amazon.DirectoryService.Model.VerifyTrustRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the VerifyTrust operation. </summary> <param name="request">Container for the necessary parameters to execute the VerifyTrust operation on AmazonDirectoryServiceClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndVerifyTrust operation.</returns> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceClient.EndVerifyTrust(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the VerifyTrust operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginVerifyTrust.</param> <returns>Returns a VerifyTrustResult from DirectoryService.</returns> </member> <member name="T:Amazon.DirectoryService.AmazonDirectoryServiceConfig"> <summary> Configuration for accessing Amazon DirectoryService service </summary> </member> <member name="M:Amazon.DirectoryService.AmazonDirectoryServiceConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DirectoryService.AmazonDirectoryServiceConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DirectoryService.AmazonDirectoryServiceConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.DirectoryService.DirectorySize"> <summary> Constants used for properties of type DirectorySize. </summary> </member> <member name="F:Amazon.DirectoryService.DirectorySize.Large"> <summary> Constant Large for DirectorySize </summary> </member> <member name="F:Amazon.DirectoryService.DirectorySize.Small"> <summary> Constant Small for DirectorySize </summary> </member> <member name="M:Amazon.DirectoryService.DirectorySize.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.DirectorySize.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.DirectoryStage"> <summary> Constants used for properties of type DirectoryStage. </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Active"> <summary> Constant Active for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Created"> <summary> Constant Created for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Creating"> <summary> Constant Creating for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Deleted"> <summary> Constant Deleted for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Deleting"> <summary> Constant Deleting for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Failed"> <summary> Constant Failed for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Impaired"> <summary> Constant Impaired for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Inoperable"> <summary> Constant Inoperable for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Requested"> <summary> Constant Requested for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.RestoreFailed"> <summary> Constant RestoreFailed for DirectoryStage </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryStage.Restoring"> <summary> Constant Restoring for DirectoryStage </summary> </member> <member name="M:Amazon.DirectoryService.DirectoryStage.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.DirectoryStage.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.DirectoryType"> <summary> Constants used for properties of type DirectoryType. </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryType.ADConnector"> <summary> Constant ADConnector for DirectoryType </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryType.MicrosoftAD"> <summary> Constant MicrosoftAD for DirectoryType </summary> </member> <member name="F:Amazon.DirectoryService.DirectoryType.SimpleAD"> <summary> Constant SimpleAD for DirectoryType </summary> </member> <member name="M:Amazon.DirectoryService.DirectoryType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.DirectoryType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.RadiusAuthenticationProtocol"> <summary> Constants used for properties of type RadiusAuthenticationProtocol. </summary> </member> <member name="F:Amazon.DirectoryService.RadiusAuthenticationProtocol.CHAP"> <summary> Constant CHAP for RadiusAuthenticationProtocol </summary> </member> <member name="F:Amazon.DirectoryService.RadiusAuthenticationProtocol.MSCHAPv1"> <summary> Constant MSCHAPv1 for RadiusAuthenticationProtocol </summary> </member> <member name="F:Amazon.DirectoryService.RadiusAuthenticationProtocol.MSCHAPv2"> <summary> Constant MSCHAPv2 for RadiusAuthenticationProtocol </summary> </member> <member name="F:Amazon.DirectoryService.RadiusAuthenticationProtocol.PAP"> <summary> Constant PAP for RadiusAuthenticationProtocol </summary> </member> <member name="M:Amazon.DirectoryService.RadiusAuthenticationProtocol.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.RadiusAuthenticationProtocol.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.RadiusStatus"> <summary> Constants used for properties of type RadiusStatus. </summary> </member> <member name="F:Amazon.DirectoryService.RadiusStatus.Completed"> <summary> Constant Completed for RadiusStatus </summary> </member> <member name="F:Amazon.DirectoryService.RadiusStatus.Creating"> <summary> Constant Creating for RadiusStatus </summary> </member> <member name="F:Amazon.DirectoryService.RadiusStatus.Failed"> <summary> Constant Failed for RadiusStatus </summary> </member> <member name="M:Amazon.DirectoryService.RadiusStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.RadiusStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.SnapshotStatus"> <summary> Constants used for properties of type SnapshotStatus. </summary> </member> <member name="F:Amazon.DirectoryService.SnapshotStatus.Completed"> <summary> Constant Completed for SnapshotStatus </summary> </member> <member name="F:Amazon.DirectoryService.SnapshotStatus.Creating"> <summary> Constant Creating for SnapshotStatus </summary> </member> <member name="F:Amazon.DirectoryService.SnapshotStatus.Failed"> <summary> Constant Failed for SnapshotStatus </summary> </member> <member name="M:Amazon.DirectoryService.SnapshotStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.SnapshotStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.SnapshotType"> <summary> Constants used for properties of type SnapshotType. </summary> </member> <member name="F:Amazon.DirectoryService.SnapshotType.Auto"> <summary> Constant Auto for SnapshotType </summary> </member> <member name="F:Amazon.DirectoryService.SnapshotType.Manual"> <summary> Constant Manual for SnapshotType </summary> </member> <member name="M:Amazon.DirectoryService.SnapshotType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.SnapshotType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.TopicStatus"> <summary> Constants used for properties of type TopicStatus. </summary> </member> <member name="F:Amazon.DirectoryService.TopicStatus.Deleted"> <summary> Constant Deleted for TopicStatus </summary> </member> <member name="F:Amazon.DirectoryService.TopicStatus.Failed"> <summary> Constant Failed for TopicStatus </summary> </member> <member name="F:Amazon.DirectoryService.TopicStatus.Registered"> <summary> Constant Registered for TopicStatus </summary> </member> <member name="F:Amazon.DirectoryService.TopicStatus.TopicNotFound"> <summary> Constant TopicNotFound for TopicStatus </summary> </member> <member name="M:Amazon.DirectoryService.TopicStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.TopicStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.TrustDirection"> <summary> Constants used for properties of type TrustDirection. </summary> </member> <member name="F:Amazon.DirectoryService.TrustDirection.OneWayIncoming"> <summary> Constant OneWayIncoming for TrustDirection </summary> </member> <member name="F:Amazon.DirectoryService.TrustDirection.OneWayOutgoing"> <summary> Constant OneWayOutgoing for TrustDirection </summary> </member> <member name="F:Amazon.DirectoryService.TrustDirection.TwoWay"> <summary> Constant TwoWay for TrustDirection </summary> </member> <member name="M:Amazon.DirectoryService.TrustDirection.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.TrustDirection.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.TrustState"> <summary> Constants used for properties of type TrustState. </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Created"> <summary> Constant Created for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Creating"> <summary> Constant Creating for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Deleted"> <summary> Constant Deleted for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Deleting"> <summary> Constant Deleting for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Failed"> <summary> Constant Failed for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Verified"> <summary> Constant Verified for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.VerifyFailed"> <summary> Constant VerifyFailed for TrustState </summary> </member> <member name="F:Amazon.DirectoryService.TrustState.Verifying"> <summary> Constant Verifying for TrustState </summary> </member> <member name="M:Amazon.DirectoryService.TrustState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.TrustState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.TrustType"> <summary> Constants used for properties of type TrustType. </summary> </member> <member name="F:Amazon.DirectoryService.TrustType.Forest"> <summary> Constant Forest for TrustType </summary> </member> <member name="M:Amazon.DirectoryService.TrustType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DirectoryService.TrustType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DirectoryService.AmazonDirectoryServiceRequest"> <summary> Base class for DirectoryService operation requests. </summary> </member> <member name="T:Amazon.DirectoryService.Model.Attribute"> <summary> Represents a named directory attribute. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Attribute.Name"> <summary> Gets and sets the property Name. <para> The name of the attribute. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Attribute.Value"> <summary> Gets and sets the property Value. <para> The value of the attribute. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.AuthenticationFailedException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.AuthenticationFailedException.#ctor(System.String)"> <summary> Constructs a new AuthenticationFailedException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.ClientException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.ClientException.#ctor(System.String)"> <summary> Constructs a new ClientException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.Computer"> <summary> Contains information about a computer account in a directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Computer.ComputerAttributes"> <summary> Gets and sets the property ComputerAttributes. <para> An array of <a>Attribute</a> objects containing the LDAP attributes that belong to the computer account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Computer.ComputerId"> <summary> Gets and sets the property ComputerId. <para> The identifier of the computer. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Computer.ComputerName"> <summary> Gets and sets the property ComputerName. <para> The computer name. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.ConnectDirectoryRequest"> <summary> Container for the parameters to the ConnectDirectory operation. Creates an AD Connector to connect to an on-premises directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.ConnectSettings"> <summary> Gets and sets the property ConnectSettings. <para> A <a>DirectoryConnectSettings</a> object that contains additional information for the operation. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.Description"> <summary> Gets and sets the property Description. <para> A textual description for the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.Name"> <summary> Gets and sets the property Name. <para> The fully-qualified name of the on-premises directory, such as <code>corp.example.com</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.Password"> <summary> Gets and sets the property Password. <para> The password for the on-premises user account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.ShortName"> <summary> Gets and sets the property ShortName. <para> The NetBIOS name of the on-premises directory, such as <code>CORP</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryRequest.Size"> <summary> Gets and sets the property Size. <para> The size of the directory. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.ConnectDirectoryResponse"> <summary> Configuration for accessing Amazon ConnectDirectory service </summary> </member> <member name="T:Amazon.DirectoryService.Model.ConnectDirectoryResult"> <summary> Contains the results of the <a>ConnectDirectory</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryResult.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the new directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.ConnectDirectoryResponse.ConnectDirectoryResult"> <summary> Gets and sets the ConnectDirectoryResult property. Represents the output of a ConnectDirectory operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateAliasRequest"> <summary> Container for the parameters to the CreateAlias operation. Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. <important> <para> After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary. </para> </important> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateAliasRequest.Alias"> <summary> Gets and sets the property Alias. <para> The requested alias. </para> <para> The alias must be unique amongst all aliases in AWS. This operation throws an <code>EntityAlreadyExistsException</code> error if the alias already exists. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateAliasRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to create the alias. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateAliasResponse"> <summary> Configuration for accessing Amazon CreateAlias service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateAliasResult"> <summary> Contains the results of the <a>CreateAlias</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateAliasResult.Alias"> <summary> Gets and sets the property Alias. <para> The alias for the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateAliasResult.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateAliasResponse.CreateAliasResult"> <summary> Gets and sets the CreateAliasResult property. Represents the output of a CreateAlias operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateComputerRequest"> <summary> Container for the parameters to the CreateComputer operation. Creates a computer account in the specified directory, and joins the computer to the directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerRequest.ComputerAttributes"> <summary> Gets and sets the property ComputerAttributes. <para> An array of <a>Attribute</a> objects that contain any LDAP attributes to apply to the computer account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerRequest.ComputerName"> <summary> Gets and sets the property ComputerName. <para> The name of the computer account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory in which to create the computer account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerRequest.OrganizationalUnitDistinguishedName"> <summary> Gets and sets the property OrganizationalUnitDistinguishedName. <para> The fully-qualified distinguished name of the organizational unit to place the computer account in. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerRequest.Password"> <summary> Gets and sets the property Password. <para> A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateComputerResponse"> <summary> Configuration for accessing Amazon CreateComputer service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateComputerResult"> <summary> Contains the results for the <a>CreateComputer</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerResult.Computer"> <summary> Gets and sets the property Computer. <para> A <a>Computer</a> object that represents the computer account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateComputerResponse.CreateComputerResult"> <summary> Gets and sets the CreateComputerResult property. Represents the output of a CreateComputer operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateDirectoryRequest"> <summary> Container for the parameters to the CreateDirectory operation. Creates a Simple AD directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.Description"> <summary> Gets and sets the property Description. <para> A textual description for the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.Name"> <summary> Gets and sets the property Name. <para> The fully qualified name for the directory, such as <code>corp.example.com</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.Password"> <summary> Gets and sets the property Password. <para> The password for the directory administrator. The directory creation process creates a directory administrator account with the username <code>Administrator</code> and this password. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.ShortName"> <summary> Gets and sets the property ShortName. <para> The short name of the directory, such as <code>CORP</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.Size"> <summary> Gets and sets the property Size. <para> The size of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryRequest.VpcSettings"> <summary> Gets and sets the property VpcSettings. <para> A <a>DirectoryVpcSettings</a> object that contains additional information for the operation. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateDirectoryResponse"> <summary> Configuration for accessing Amazon CreateDirectory service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateDirectoryResult"> <summary> Contains the results of the <a>CreateDirectory</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryResult.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory that was created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateDirectoryResponse.CreateDirectoryResult"> <summary> Gets and sets the CreateDirectoryResult property. Represents the output of a CreateDirectory operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateMicrosoftADRequest"> <summary> Container for the parameters to the CreateMicrosoftAD operation. Creates a Microsoft AD in the AWS cloud. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADRequest.Description"> <summary> Gets and sets the property Description. <para> A textual description for the directory. This label will appear on the AWS console <code>Directory Details</code> page after the directory is created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADRequest.Name"> <summary> Gets and sets the property Name. <para> The fully qualified domain name for the directory, such as <code>corp.example.com</code>. This name will resolve inside your VPC only. It does not need to be publicly resolvable. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADRequest.Password"> <summary> Gets and sets the property Password. <para> The password for the default administrative user named <code>Admin</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADRequest.ShortName"> <summary> Gets and sets the property ShortName. <para> The NetBIOS name for your domain. A short identifier for your domain, such as <code>CORP</code>. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, <code>CORP</code> for the directory DNS <code>corp.example.com</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADRequest.VpcSettings"> <summary> Gets and sets the property VpcSettings. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateMicrosoftADResponse"> <summary> Configuration for accessing Amazon CreateMicrosoftAD service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateMicrosoftADResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADResult.DirectoryId"> <summary> Gets and sets the property DirectoryId. The identifier of the directory that was created. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateMicrosoftADResponse.CreateMicrosoftADResult"> <summary> Gets and sets the CreateMicrosoftADResult property. Represents the output of a CreateMicrosoftAD operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateSnapshotRequest"> <summary> Container for the parameters to the CreateSnapshot operation. Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud. <note> <para> You cannot take snapshots of AD Connector directories. </para> </note> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateSnapshotRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory of which to take a snapshot. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateSnapshotRequest.Name"> <summary> Gets and sets the property Name. <para> The descriptive name to apply to the snapshot. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateSnapshotResponse"> <summary> Configuration for accessing Amazon CreateSnapshot service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateSnapshotResult"> <summary> Contains the results of the <a>CreateSnapshot</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateSnapshotResult.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The identifier of the snapshot that was created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateSnapshotResponse.CreateSnapshotResult"> <summary> Gets and sets the CreateSnapshotResult property. Represents the output of a CreateSnapshot operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateTrustRequest"> <summary> Container for the parameters to the CreateTrust operation. AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials. <para> This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustRequest.RemoteDomainName"> <summary> Gets and sets the property RemoteDomainName. The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustRequest.TrustDirection"> <summary> Gets and sets the property TrustDirection. The direction of the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustRequest.TrustPassword"> <summary> Gets and sets the property TrustPassword. The trust password. The must be the same password that was used when creating the trust relationship on the external domain. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustRequest.TrustType"> <summary> Gets and sets the property TrustType. The trust relationship type. </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateTrustResponse"> <summary> Configuration for accessing Amazon CreateTrust service </summary> </member> <member name="T:Amazon.DirectoryService.Model.CreateTrustResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustResult.TrustId"> <summary> Gets and sets the property TrustId. A unique identifier for the trust relationship that was created. </summary> </member> <member name="P:Amazon.DirectoryService.Model.CreateTrustResponse.CreateTrustResult"> <summary> Gets and sets the CreateTrustResult property. Represents the output of a CreateTrust operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteDirectoryRequest"> <summary> Container for the parameters to the DeleteDirectory operation. Deletes an AWS Directory Service directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteDirectoryRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory to delete. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteDirectoryResponse"> <summary> Configuration for accessing Amazon DeleteDirectory service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteDirectoryResult"> <summary> Contains the results of the <a>DeleteDirectory</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteDirectoryResult.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The directory identifier. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteDirectoryResponse.DeleteDirectoryResult"> <summary> Gets and sets the DeleteDirectoryResult property. Represents the output of a DeleteDirectory operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteSnapshotRequest"> <summary> Container for the parameters to the DeleteSnapshot operation. Deletes a directory snapshot. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteSnapshotRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The identifier of the directory snapshot to be deleted. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteSnapshotResponse"> <summary> Configuration for accessing Amazon DeleteSnapshot service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteSnapshotResult"> <summary> Contains the results of the <a>DeleteSnapshot</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteSnapshotResult.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The identifier of the directory snapshot that was deleted. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteSnapshotResponse.DeleteSnapshotResult"> <summary> Gets and sets the DeleteSnapshotResult property. Represents the output of a DeleteSnapshot operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteTrustRequest"> <summary> Container for the parameters to the DeleteTrust operation. Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteTrustRequest.TrustId"> <summary> Gets and sets the property TrustId. The Trust ID of the trust relationship to be deleted. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteTrustResponse"> <summary> Configuration for accessing Amazon DeleteTrust service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeleteTrustResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteTrustResult.TrustId"> <summary> Gets and sets the property TrustId. The Trust ID of the trust relationship that was deleted. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeleteTrustResponse.DeleteTrustResult"> <summary> Gets and sets the DeleteTrustResult property. Represents the output of a DeleteTrust operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeregisterEventTopicRequest"> <summary> Container for the parameters to the DeregisterEventTopic operation. Removes the specified directory as a publisher to the specified SNS topic. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeregisterEventTopicRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeregisterEventTopicRequest.TopicName"> <summary> Gets and sets the property TopicName. <para> The name of the SNS topic from which to remove the directory as a publisher. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeregisterEventTopicResponse"> <summary> Configuration for accessing Amazon DeregisterEventTopic service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DeregisterEventTopicResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DeregisterEventTopicResponse.DeregisterEventTopicResult"> <summary> Gets and sets the DeregisterEventTopicResult property. Represents the output of a DeregisterEventTopic operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeDirectoriesRequest"> <summary> Container for the parameters to the DescribeDirectories operation. Obtains information about the directories that belong to this account. <para> You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned. </para> <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesRequest.DirectoryIds"> <summary> Gets and sets the property DirectoryIds. <para> A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned. </para> <para> An empty list results in an <code>InvalidParameterException</code> being thrown. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>DescribeDirectoriesResult.NextToken</i> value from a previous call to <a>DescribeDirectories</a>. Pass null if this is the first call. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeDirectoriesResponse"> <summary> Configuration for accessing Amazon DescribeDirectories service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeDirectoriesResult"> <summary> Contains the results of the <a>DescribeDirectories</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesResult.DirectoryDescriptions"> <summary> Gets and sets the property DirectoryDescriptions. <para> The list of <a>DirectoryDescription</a> objects that were retrieved. </para> <para> It is possible that this list contains less than the number of items specified in the <i>Limit</i> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this value for the <i>NextToken</i> parameter in a subsequent call to <a>DescribeDirectories</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeDirectoriesResponse.DescribeDirectoriesResult"> <summary> Gets and sets the DescribeDirectoriesResult property. Represents the output of a DescribeDirectories operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeEventTopicsRequest"> <summary> Container for the parameters to the DescribeEventTopics operation. Obtains information about which SNS topics receive status messages from the specified directory. <para> If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeEventTopicsRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeEventTopicsRequest.TopicNames"> <summary> Gets and sets the property TopicNames. <para> A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned. </para> <para> An empty list results in an <code>InvalidParameterException</code> being thrown. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeEventTopicsResponse"> <summary> Configuration for accessing Amazon DescribeEventTopics service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeEventTopicsResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeEventTopicsResult.EventTopics"> <summary> Gets and sets the property EventTopics. <para> A list of SNS topic names that receive status messages from the specified Directory ID. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeEventTopicsResponse.DescribeEventTopicsResult"> <summary> Gets and sets the DescribeEventTopicsResult property. Represents the output of a DescribeEventTopics operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeSnapshotsRequest"> <summary> Container for the parameters to the DescribeSnapshots operation. Obtains information about the directory snapshots that belong to this account. <para> This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items. </para> <para> You can also specify a maximum number of return results with the <i>Limit</i> parameter. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to retrieve snapshot information. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of objects to return. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to <a>DescribeSnapshots</a>. Pass null if this is the first call. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsRequest.SnapshotIds"> <summary> Gets and sets the property SnapshotIds. <para> A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the <i>Limit</i> and <i>NextToken</i> members. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeSnapshotsResponse"> <summary> Configuration for accessing Amazon DescribeSnapshots service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeSnapshotsResult"> <summary> Contains the results of the <a>DescribeSnapshots</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this value in the <i>NextToken</i> member of a subsequent call to <a>DescribeSnapshots</a>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsResult.Snapshots"> <summary> Gets and sets the property Snapshots. <para> The list of <a>Snapshot</a> objects that were retrieved. </para> <para> It is possible that this list contains less than the number of items specified in the <i>Limit</i> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeSnapshotsResponse.DescribeSnapshotsResult"> <summary> Gets and sets the DescribeSnapshotsResult property. Represents the output of a DescribeSnapshots operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeTrustsRequest"> <summary> Container for the parameters to the DescribeTrusts operation. Obtains information about the trust relationships for this account. <para> If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. The Directory ID of the AWS directory that is a part of the requested trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsRequest.Limit"> <summary> Gets and sets the property Limit. The maximum number of objects to return. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <i>DescribeTrustsResult.NextToken</i> value from a previous call to <a>DescribeTrusts</a>. Pass null if this is the first call. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsRequest.TrustIds"> <summary> Gets and sets the property TrustIds. <para> A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned. </para> <para> An empty list results in an <code>InvalidParameterException</code> being thrown. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeTrustsResponse"> <summary> Configuration for accessing Amazon DescribeTrusts service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DescribeTrustsResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> If not null, more results are available. Pass this value for the <i>NextToken</i> parameter in a subsequent call to <a>DescribeTrusts</a> to retrieve the next set of items. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsResult.Trusts"> <summary> Gets and sets the property Trusts. <para> The list of Trust objects that were retrieved. </para> <para> It is possible that this list contains less than the number of items specified in the <i>Limit</i> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DescribeTrustsResponse.DescribeTrustsResult"> <summary> Gets and sets the DescribeTrustsResult property. Represents the output of a DescribeTrusts operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryConnectSettings"> <summary> Contains information for the <a>ConnectDirectory</a> operation when an AD Connector directory is being created. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettings.CustomerDnsIps"> <summary> Gets and sets the property CustomerDnsIps. <para> A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettings.CustomerUserName"> <summary> Gets and sets the property CustomerUserName. <para> The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges: </para> <ul> <li>Read users and groups</li> <li>Create computer objects</li> <li>Join computers to the domain</li> </ul> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettings.SubnetIds"> <summary> Gets and sets the property SubnetIds. <para> A list of subnet identifiers in the VPC in which the AD Connector is created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettings.VpcId"> <summary> Gets and sets the property VpcId. <para> The identifier of the VPC in which the AD Connector is created. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription"> <summary> Contains information about an AD Connector directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> A list of the Availability Zones that the directory is in. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.ConnectIps"> <summary> Gets and sets the property ConnectIps. <para> The IP addresses of the AD Connector servers. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.CustomerUserName"> <summary> Gets and sets the property CustomerUserName. <para> The username of the service account in the on-premises directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.SecurityGroupId"> <summary> Gets and sets the property SecurityGroupId. <para> The security group identifier for the AD Connector directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.SubnetIds"> <summary> Gets and sets the property SubnetIds. <para> A list of subnet identifiers in the VPC that the AD connector is in. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryConnectSettingsDescription.VpcId"> <summary> Gets and sets the property VpcId. <para> The identifier of the VPC that the AD Connector is in. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryDescription"> <summary> Contains information about an AWS Directory Service directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.AccessUrl"> <summary> Gets and sets the property AccessUrl. <para> The access URL for the directory, such as <code>http://<![CDATA[<]]>alias<![CDATA[>]]>.awsapps.com</code>. If no alias has been created for the directory, <code><![CDATA[<]]>alias<![CDATA[>]]></code> is the directory identifier, such as <code>d-XXXXXXXXXX</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Alias"> <summary> Gets and sets the property Alias. <para> The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as <code>d-XXXXXXXXXX</code>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.ConnectSettings"> <summary> Gets and sets the property ConnectSettings. <para> A <a>DirectoryConnectSettingsDescription</a> object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Description"> <summary> Gets and sets the property Description. <para> The textual description for the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The directory identifier. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.DnsIpAddrs"> <summary> Gets and sets the property DnsIpAddrs. <para> The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.LaunchTime"> <summary> Gets and sets the property LaunchTime. <para> Specifies when the directory was created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Name"> <summary> Gets and sets the property Name. <para> The fully-qualified name of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.RadiusSettings"> <summary> Gets and sets the property RadiusSettings. <para> A <a>RadiusSettings</a> object that contains information about the RADIUS server configured for this directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.RadiusStatus"> <summary> Gets and sets the property RadiusStatus. <para> The status of the RADIUS MFA server connection. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.ShortName"> <summary> Gets and sets the property ShortName. <para> The short name of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Size"> <summary> Gets and sets the property Size. <para> The directory size. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.SsoEnabled"> <summary> Gets and sets the property SsoEnabled. <para> Indicates if single-sign on is enabled for the directory. For more information, see <a>EnableSso</a> and <a>DisableSso</a>. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Stage"> <summary> Gets and sets the property Stage. <para> The current stage of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.StageLastUpdatedDateTime"> <summary> Gets and sets the property StageLastUpdatedDateTime. <para> The date and time that the stage was last updated. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.StageReason"> <summary> Gets and sets the property StageReason. <para> Additional information about the directory stage. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.Type"> <summary> Gets and sets the property Type. <para> The directory size. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryDescription.VpcSettings"> <summary> Gets and sets the property VpcSettings. <para> A <a>DirectoryVpcSettingsDescription</a> object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryLimitExceededException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.DirectoryLimitExceededException.#ctor(System.String)"> <summary> Constructs a new DirectoryLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryLimits"> <summary> Contains directory limit information for a region. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyDirectoriesCurrentCount"> <summary> Gets and sets the property CloudOnlyDirectoriesCurrentCount. <para> The current number of cloud directories in the region. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyDirectoriesLimit"> <summary> Gets and sets the property CloudOnlyDirectoriesLimit. <para> The maximum number of cloud directories allowed in the region. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyDirectoriesLimitReached"> <summary> Gets and sets the property CloudOnlyDirectoriesLimitReached. <para> Indicates if the cloud directory limit has been reached. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyMicrosoftADCurrentCount"> <summary> Gets and sets the property CloudOnlyMicrosoftADCurrentCount. The current number of Microsoft AD directories in the region. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyMicrosoftADLimit"> <summary> Gets and sets the property CloudOnlyMicrosoftADLimit. The maximum number of Microsoft AD directories allowed in the region. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.CloudOnlyMicrosoftADLimitReached"> <summary> Gets and sets the property CloudOnlyMicrosoftADLimitReached. Indicates if the Microsoft AD directory limit has been reached. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.ConnectedDirectoriesCurrentCount"> <summary> Gets and sets the property ConnectedDirectoriesCurrentCount. <para> The current number of connected directories in the region. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.ConnectedDirectoriesLimit"> <summary> Gets and sets the property ConnectedDirectoriesLimit. <para> The maximum number of connected directories allowed in the region. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryLimits.ConnectedDirectoriesLimitReached"> <summary> Gets and sets the property ConnectedDirectoriesLimitReached. <para> Indicates if the connected directory limit has been reached. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryUnavailableException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.DirectoryUnavailableException.#ctor(System.String)"> <summary> Constructs a new DirectoryUnavailableException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryVpcSettings"> <summary> Contains VPC information for the <a>CreateDirectory</a> or <a>CreateMicrosoftAD</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettings.SubnetIds"> <summary> Gets and sets the property SubnetIds. <para> The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettings.VpcId"> <summary> Gets and sets the property VpcId. <para> The identifier of the VPC in which to create the directory. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DirectoryVpcSettingsDescription"> <summary> Contains information about the directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettingsDescription.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> The list of Availability Zones that the directory is in. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettingsDescription.SecurityGroupId"> <summary> Gets and sets the property SecurityGroupId. <para> The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettingsDescription.SubnetIds"> <summary> Gets and sets the property SubnetIds. <para> The identifiers of the subnets for the directory servers. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DirectoryVpcSettingsDescription.VpcId"> <summary> Gets and sets the property VpcId. <para> The identifier of the VPC that the directory is in. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableRadiusRequest"> <summary> Container for the parameters to the DisableRadius operation. Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableRadiusRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to disable MFA. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableRadiusResponse"> <summary> Configuration for accessing Amazon DisableRadius service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableRadiusResult"> <summary> Contains the results of the <a>DisableRadius</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableRadiusResponse.DisableRadiusResult"> <summary> Gets and sets the DisableRadiusResult property. Represents the output of a DisableRadius operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableSsoRequest"> <summary> Container for the parameters to the DisableSso operation. Disables single-sign on for a directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableSsoRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to disable single-sign on. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableSsoRequest.Password"> <summary> Gets and sets the property Password. <para> The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the <i>UserName</i> parameter. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableSsoRequest.UserName"> <summary> Gets and sets the property UserName. <para> The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name. </para> <para> If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableSsoResponse"> <summary> Configuration for accessing Amazon DisableSso service </summary> </member> <member name="T:Amazon.DirectoryService.Model.DisableSsoResult"> <summary> Contains the results of the <a>DisableSso</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.DisableSsoResponse.DisableSsoResult"> <summary> Gets and sets the DisableSsoResult property. Represents the output of a DisableSso operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableRadiusRequest"> <summary> Container for the parameters to the EnableRadius operation. Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableRadiusRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to enable MFA. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableRadiusRequest.RadiusSettings"> <summary> Gets and sets the property RadiusSettings. <para> A <a>RadiusSettings</a> object that contains information about the RADIUS server. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableRadiusResponse"> <summary> Configuration for accessing Amazon EnableRadius service </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableRadiusResult"> <summary> Contains the results of the <a>EnableRadius</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableRadiusResponse.EnableRadiusResult"> <summary> Gets and sets the EnableRadiusResult property. Represents the output of a EnableRadius operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableSsoRequest"> <summary> Container for the parameters to the EnableSso operation. Enables single-sign on for a directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableSsoRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to enable single-sign on. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableSsoRequest.Password"> <summary> Gets and sets the property Password. <para> The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the <i>UserName</i> parameter. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableSsoRequest.UserName"> <summary> Gets and sets the property UserName. <para> The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name. </para> <para> If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableSsoResponse"> <summary> Configuration for accessing Amazon EnableSso service </summary> </member> <member name="T:Amazon.DirectoryService.Model.EnableSsoResult"> <summary> Contains the results of the <a>EnableSso</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.EnableSsoResponse.EnableSsoResult"> <summary> Gets and sets the EnableSsoResult property. Represents the output of a EnableSso operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.EntityAlreadyExistsException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.EntityAlreadyExistsException.#ctor(System.String)"> <summary> Constructs a new EntityAlreadyExistsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.EntityDoesNotExistException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.EntityDoesNotExistException.#ctor(System.String)"> <summary> Constructs a new EntityDoesNotExistException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.EventTopic"> <summary> Information about SNS topic and AWS Directory Service directory associations. </summary> </member> <member name="P:Amazon.DirectoryService.Model.EventTopic.CreatedDateTime"> <summary> Gets and sets the property CreatedDateTime. <para> The date and time of when you associated your directory with the SNS topic. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EventTopic.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EventTopic.Status"> <summary> Gets and sets the property Status. <para> The topic registration status. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EventTopic.TopicArn"> <summary> Gets and sets the property TopicArn. <para> The SNS topic ARN (Amazon Resource Name). </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.EventTopic.TopicName"> <summary> Gets and sets the property TopicName. <para> The name of an AWS SNS topic the receives status messages from the directory. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetDirectoryLimitsRequest"> <summary> Container for the parameters to the GetDirectoryLimits operation. Obtains directory limit information for the current region. </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetDirectoryLimitsResponse"> <summary> Configuration for accessing Amazon GetDirectoryLimits service </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetDirectoryLimitsResult"> <summary> Contains the results of the <a>GetDirectoryLimits</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.GetDirectoryLimitsResult.DirectoryLimits"> <summary> Gets and sets the property DirectoryLimits. <para> A <a>DirectoryLimits</a> object that contains the directory limits for the current region. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.GetDirectoryLimitsResponse.GetDirectoryLimitsResult"> <summary> Gets and sets the GetDirectoryLimitsResult property. Represents the output of a GetDirectoryLimits operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetSnapshotLimitsRequest"> <summary> Container for the parameters to the GetSnapshotLimits operation. Obtains the manual snapshot limits for a directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.GetSnapshotLimitsRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> Contains the identifier of the directory to obtain the limits for. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetSnapshotLimitsResponse"> <summary> Configuration for accessing Amazon GetSnapshotLimits service </summary> </member> <member name="T:Amazon.DirectoryService.Model.GetSnapshotLimitsResult"> <summary> Contains the results of the <a>GetSnapshotLimits</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.GetSnapshotLimitsResult.SnapshotLimits"> <summary> Gets and sets the property SnapshotLimits. <para> A <a>SnapshotLimits</a> object that contains the manual snapshot limits for the specified directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.GetSnapshotLimitsResponse.GetSnapshotLimitsResult"> <summary> Gets and sets the GetSnapshotLimitsResult property. Represents the output of a GetSnapshotLimits operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.InsufficientPermissionsException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.InsufficientPermissionsException.#ctor(System.String)"> <summary> Constructs a new InsufficientPermissionsException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.InvalidNextTokenException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.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.DirectoryService.Model.InvalidParameterException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.InvalidParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.RadiusSettings"> <summary> Contains information about a Remote Authentication Dial In User Service (RADIUS) server. </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.AuthenticationProtocol"> <summary> Gets and sets the property AuthenticationProtocol. <para> The protocol specified for your RADIUS endpoints. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.DisplayLabel"> <summary> Gets and sets the property DisplayLabel. <para> Not currently used. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.RadiusPort"> <summary> Gets and sets the property RadiusPort. <para> The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.RadiusRetries"> <summary> Gets and sets the property RadiusRetries. <para> The maximum number of times that communication with the RADIUS server is attempted. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.RadiusServers"> <summary> Gets and sets the property RadiusServers. <para> An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.RadiusTimeout"> <summary> Gets and sets the property RadiusTimeout. <para> The amount of time, in seconds, to wait for the RADIUS server to respond. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.SharedSecret"> <summary> Gets and sets the property SharedSecret. <para> The shared secret code that was specified when your RADIUS endpoints were created. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RadiusSettings.UseSameUsername"> <summary> Gets and sets the property UseSameUsername. <para> Not currently used. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.RegisterEventTopicRequest"> <summary> Container for the parameters to the RegisterEventTopic operation. Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status. </summary> </member> <member name="P:Amazon.DirectoryService.Model.RegisterEventTopicRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The Directory ID that will publish status messages to the SNS topic. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RegisterEventTopicRequest.TopicName"> <summary> Gets and sets the property TopicName. <para> The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.RegisterEventTopicResponse"> <summary> Configuration for accessing Amazon RegisterEventTopic service </summary> </member> <member name="T:Amazon.DirectoryService.Model.RegisterEventTopicResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RegisterEventTopicResponse.RegisterEventTopicResult"> <summary> Gets and sets the RegisterEventTopicResult property. Represents the output of a RegisterEventTopic operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.RestoreFromSnapshotRequest"> <summary> Container for the parameters to the RestoreFromSnapshot operation. Restores a directory using an existing directory snapshot. <para> When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten. </para> <para> This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.RestoreFromSnapshotRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The identifier of the snapshot to restore from. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.RestoreFromSnapshotResponse"> <summary> Configuration for accessing Amazon RestoreFromSnapshot service </summary> </member> <member name="T:Amazon.DirectoryService.Model.RestoreFromSnapshotResult"> <summary> Contains the results of the <a>RestoreFromSnapshot</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.RestoreFromSnapshotResponse.RestoreFromSnapshotResult"> <summary> Gets and sets the RestoreFromSnapshotResult property. Represents the output of a RestoreFromSnapshot operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.ServiceException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.ServiceException.#ctor(System.String)"> <summary> Constructs a new ServiceException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.Snapshot"> <summary> Describes a directory snapshot. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The directory identifier. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.Name"> <summary> Gets and sets the property Name. <para> The descriptive name of the snapshot. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot identifier. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.StartTime"> <summary> Gets and sets the property StartTime. <para> The date and time that the snapshot was taken. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.Status"> <summary> Gets and sets the property Status. <para> The snapshot status. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.Snapshot.Type"> <summary> Gets and sets the property Type. <para> The snapshot type. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.SnapshotLimitExceededException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.SnapshotLimitExceededException.#ctor(System.String)"> <summary> Constructs a new SnapshotLimitExceededException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.SnapshotLimits"> <summary> Contains manual snapshot limit information for a directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.SnapshotLimits.ManualSnapshotsCurrentCount"> <summary> Gets and sets the property ManualSnapshotsCurrentCount. <para> The current number of manual snapshots of the directory. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.SnapshotLimits.ManualSnapshotsLimit"> <summary> Gets and sets the property ManualSnapshotsLimit. <para> The maximum number of manual snapshots allowed. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.SnapshotLimits.ManualSnapshotsLimitReached"> <summary> Gets and sets the property ManualSnapshotsLimitReached. <para> Indicates if the manual snapshot limit has been reached. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.Trust"> <summary> Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.CreatedDateTime"> <summary> Gets and sets the property CreatedDateTime. The date and time that the trust relationship was created. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.DirectoryId"> <summary> Gets and sets the property DirectoryId. The Directory ID of the AWS directory involved in the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.LastUpdatedDateTime"> <summary> Gets and sets the property LastUpdatedDateTime. The date and time that the trust relationship was last updated. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.RemoteDomainName"> <summary> Gets and sets the property RemoteDomainName. The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.StateLastUpdatedDateTime"> <summary> Gets and sets the property StateLastUpdatedDateTime. The date and time that the TrustState was last updated. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.TrustDirection"> <summary> Gets and sets the property TrustDirection. The trust relationship direction. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.TrustId"> <summary> Gets and sets the property TrustId. The unique ID of the trust relationship. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.TrustState"> <summary> Gets and sets the property TrustState. The trust relationship state. </summary> </member> <member name="P:Amazon.DirectoryService.Model.Trust.TrustType"> <summary> Gets and sets the property TrustType. The trust relationship type. </summary> </member> <member name="T:Amazon.DirectoryService.Model.UnsupportedOperationException"> <summary> DirectoryService exception </summary> </member> <member name="M:Amazon.DirectoryService.Model.UnsupportedOperationException.#ctor(System.String)"> <summary> Constructs a new UnsupportedOperationException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DirectoryService.Model.UpdateRadiusRequest"> <summary> Container for the parameters to the UpdateRadius operation. Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory. </summary> </member> <member name="P:Amazon.DirectoryService.Model.UpdateRadiusRequest.DirectoryId"> <summary> Gets and sets the property DirectoryId. <para> The identifier of the directory for which to update the RADIUS server information. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.UpdateRadiusRequest.RadiusSettings"> <summary> Gets and sets the property RadiusSettings. <para> A <a>RadiusSettings</a> object that contains information about the RADIUS server. </para> </summary> </member> <member name="T:Amazon.DirectoryService.Model.UpdateRadiusResponse"> <summary> Configuration for accessing Amazon UpdateRadius service </summary> </member> <member name="T:Amazon.DirectoryService.Model.UpdateRadiusResult"> <summary> Contains the results of the <a>UpdateRadius</a> operation. </summary> </member> <member name="P:Amazon.DirectoryService.Model.UpdateRadiusResponse.UpdateRadiusResult"> <summary> Gets and sets the UpdateRadiusResult property. Represents the output of a UpdateRadius operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.VerifyTrustRequest"> <summary> Container for the parameters to the VerifyTrust operation. AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships. <para> This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain. </para> </summary> </member> <member name="P:Amazon.DirectoryService.Model.VerifyTrustRequest.TrustId"> <summary> Gets and sets the property TrustId. The unique Trust ID of the trust relationship to verify. </summary> </member> <member name="T:Amazon.DirectoryService.Model.VerifyTrustResponse"> <summary> Configuration for accessing Amazon VerifyTrust service </summary> </member> <member name="T:Amazon.DirectoryService.Model.VerifyTrustResult"> <summary> </summary> </member> <member name="P:Amazon.DirectoryService.Model.VerifyTrustResult.TrustId"> <summary> Gets and sets the property TrustId. The unique Trust ID of the trust relationship that was verified. </summary> </member> <member name="P:Amazon.DirectoryService.Model.VerifyTrustResponse.VerifyTrustResult"> <summary> Gets and sets the VerifyTrustResult property. Represents the output of a VerifyTrust operation. </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.AttributeMarshaller"> <summary> Attribute Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.AttributeUnmarshaller"> <summary> Response Unmarshaller for Attribute Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.ComputerUnmarshaller"> <summary> Response Unmarshaller for Computer Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.ConnectDirectoryRequestMarshaller"> <summary> ConnectDirectory Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.ConnectDirectoryResponseUnmarshaller"> <summary> Response Unmarshaller for ConnectDirectory operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateAliasRequestMarshaller"> <summary> CreateAlias Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateAliasResponseUnmarshaller"> <summary> Response Unmarshaller for CreateAlias operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateComputerRequestMarshaller"> <summary> CreateComputer Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateComputerResponseUnmarshaller"> <summary> Response Unmarshaller for CreateComputer operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateDirectoryRequestMarshaller"> <summary> CreateDirectory Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateDirectoryResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDirectory operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateMicrosoftADRequestMarshaller"> <summary> CreateMicrosoftAD Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateMicrosoftADResponseUnmarshaller"> <summary> Response Unmarshaller for CreateMicrosoftAD operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateSnapshotRequestMarshaller"> <summary> CreateSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSnapshot operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateTrustRequestMarshaller"> <summary> CreateTrust Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.CreateTrustResponseUnmarshaller"> <summary> Response Unmarshaller for CreateTrust operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteDirectoryRequestMarshaller"> <summary> DeleteDirectory Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteDirectoryResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDirectory operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteSnapshotRequestMarshaller"> <summary> DeleteSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSnapshot operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteTrustRequestMarshaller"> <summary> DeleteTrust Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeleteTrustResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTrust operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeregisterEventTopicRequestMarshaller"> <summary> DeregisterEventTopic Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DeregisterEventTopicResponseUnmarshaller"> <summary> Response Unmarshaller for DeregisterEventTopic operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeDirectoriesRequestMarshaller"> <summary> DescribeDirectories Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeDirectoriesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDirectories operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeEventTopicsRequestMarshaller"> <summary> DescribeEventTopics Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeEventTopicsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeEventTopics operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeSnapshotsRequestMarshaller"> <summary> DescribeSnapshots Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeSnapshotsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSnapshots operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeTrustsRequestMarshaller"> <summary> DescribeTrusts Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DescribeTrustsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTrusts operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryConnectSettingsDescriptionUnmarshaller"> <summary> Response Unmarshaller for DirectoryConnectSettingsDescription Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryConnectSettingsMarshaller"> <summary> DirectoryConnectSettings Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryDescriptionUnmarshaller"> <summary> Response Unmarshaller for DirectoryDescription Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryLimitsUnmarshaller"> <summary> Response Unmarshaller for DirectoryLimits Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryVpcSettingsDescriptionUnmarshaller"> <summary> Response Unmarshaller for DirectoryVpcSettingsDescription Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DirectoryVpcSettingsMarshaller"> <summary> DirectoryVpcSettings Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DisableRadiusRequestMarshaller"> <summary> DisableRadius Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DisableRadiusResponseUnmarshaller"> <summary> Response Unmarshaller for DisableRadius operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DisableSsoRequestMarshaller"> <summary> DisableSso Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.DisableSsoResponseUnmarshaller"> <summary> Response Unmarshaller for DisableSso operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.EnableRadiusRequestMarshaller"> <summary> EnableRadius Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.EnableRadiusResponseUnmarshaller"> <summary> Response Unmarshaller for EnableRadius operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.EnableSsoRequestMarshaller"> <summary> EnableSso Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.EnableSsoResponseUnmarshaller"> <summary> Response Unmarshaller for EnableSso operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.EventTopicUnmarshaller"> <summary> Response Unmarshaller for EventTopic Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.GetDirectoryLimitsRequestMarshaller"> <summary> GetDirectoryLimits Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.GetDirectoryLimitsResponseUnmarshaller"> <summary> Response Unmarshaller for GetDirectoryLimits operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.GetSnapshotLimitsRequestMarshaller"> <summary> GetSnapshotLimits Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.GetSnapshotLimitsResponseUnmarshaller"> <summary> Response Unmarshaller for GetSnapshotLimits operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RadiusSettingsMarshaller"> <summary> RadiusSettings Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RadiusSettingsUnmarshaller"> <summary> Response Unmarshaller for RadiusSettings Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RegisterEventTopicRequestMarshaller"> <summary> RegisterEventTopic Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RegisterEventTopicResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterEventTopic operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RestoreFromSnapshotRequestMarshaller"> <summary> RestoreFromSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.RestoreFromSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for RestoreFromSnapshot operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.SnapshotLimitsUnmarshaller"> <summary> Response Unmarshaller for SnapshotLimits Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.SnapshotUnmarshaller"> <summary> Response Unmarshaller for Snapshot Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.TrustUnmarshaller"> <summary> Response Unmarshaller for Trust Object </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.UpdateRadiusRequestMarshaller"> <summary> UpdateRadius Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.UpdateRadiusResponseUnmarshaller"> <summary> Response Unmarshaller for UpdateRadius operation </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.VerifyTrustRequestMarshaller"> <summary> VerifyTrust Request Marshaller </summary> </member> <member name="T:Amazon.DirectoryService.Model.Internal.MarshallTransformations.VerifyTrustResponseUnmarshaller"> <summary> Response Unmarshaller for VerifyTrust operation </summary> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBClient"> <summary> Implementation for accessing DynamoDB Amazon DynamoDB <para> This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API. </para> <para> This guide is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/gettingstartedguide/">Amazon DynamoDB Getting Started Guide</a> - provides hands-on exercises that help you learn the basics of working with DynamoDB. <i>If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide.</i> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> - contains detailed information about DynamoDB concepts, usage, and best practices. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/">Amazon DynamoDB Streams API Reference</a> - provides descriptions and samples of the DynamoDB Streams API. (For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.) </para> </li> </ul> <para> Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html">Using the AWS SDKs with DynamoDB</a> in the Amazon DynamoDB Developer Guide. </para> <para> If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html">Using the DynamoDB API</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> The following are short descriptions of each low-level API action, organized by function. </para> <para> <b>Managing Tables</b> </para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes. </para> </li> <li> <para> <i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and index information. </para> </li> <li> <para> <i>UpdateTable</i> - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table. </para> </li> <li> <para> <i>ListTables</i> - Returns a list of all tables associated with the current AWS account and endpoint. </para> </li> <li> <para> <i>DeleteTable</i> - Deletes a table and all of its indexes. </para> </li> </ul> <para> For conceptual information about managing tables, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html">Working with Tables</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Reading Data</b> </para> <ul> <li> <para> <i>GetItem</i> - Returns a set of attributes for the item that has a given primary key. By default, <i>GetItem</i> performs an eventually consistent read; however, applications can request a strongly consistent read instead. </para> </li> <li> <para> <i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using their primary keys, from one table or multiple tables. The response from <i>BatchGetItem</i> has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. </para> </li> <li> <para> <i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. <i>Query</i> supports either eventual or strong consistency. A single response has a size limit of 1 MB. </para> </li> <li> <para> <i>Scan</i> - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. <i>Scan</i> can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, <i>Scan</i> should not be used for any application query use case that requires predictable performance. </para> </li> </ul> <para> For conceptual information about reading data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Modifying Data</b> </para> <ul> <li> <para> <i>PutItem</i> - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist. </para> </li> <li> <para> <i>UpdateItem</i> - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>DeleteItem</i> - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB. </para> </li> </ul> <para> For conceptual information about modifying data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.IAmazonDynamoDB"> <summary> Interface for accessing DynamoDB Amazon DynamoDB <para> This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API. </para> <para> This guide is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/gettingstartedguide/">Amazon DynamoDB Getting Started Guide</a> - provides hands-on exercises that help you learn the basics of working with DynamoDB. <i>If you are new to DynamoDB, we recommend that you begin with the Getting Started Guide.</i> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> - contains detailed information about DynamoDB concepts, usage, and best practices. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/dynamodbstreams/latest/APIReference/">Amazon DynamoDB Streams API Reference</a> - provides descriptions and samples of the DynamoDB Streams API. (For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.) </para> </li> </ul> <para> Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/UsingAWSSDK.html">Using the AWS SDKs with DynamoDB</a> in the Amazon DynamoDB Developer Guide. </para> <para> If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/API.html">Using the DynamoDB API</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> The following are short descriptions of each low-level API action, organized by function. </para> <para> <b>Managing Tables</b> </para> <ul> <li> <para> <i>CreateTable</i> - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes. </para> </li> <li> <para> <i>DescribeTable</i> - Returns metadata for a table, such as table size, status, and index information. </para> </li> <li> <para> <i>UpdateTable</i> - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table. </para> </li> <li> <para> <i>ListTables</i> - Returns a list of all tables associated with the current AWS account and endpoint. </para> </li> <li> <para> <i>DeleteTable</i> - Deletes a table and all of its indexes. </para> </li> </ul> <para> For conceptual information about managing tables, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html">Working with Tables</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Reading Data</b> </para> <ul> <li> <para> <i>GetItem</i> - Returns a set of attributes for the item that has a given primary key. By default, <i>GetItem</i> performs an eventually consistent read; however, applications can request a strongly consistent read instead. </para> </li> <li> <para> <i>BatchGetItem</i> - Performs multiple <i>GetItem</i> requests for data items using their primary keys, from one table or multiple tables. The response from <i>BatchGetItem</i> has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used. </para> </li> <li> <para> <i>Query</i> - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. <i>Query</i> supports either eventual or strong consistency. A single response has a size limit of 1 MB. </para> </li> <li> <para> <i>Scan</i> - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. <i>Scan</i> can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, <i>Scan</i> should not be used for any application query use case that requires predictable performance. </para> </li> </ul> <para> For conceptual information about reading data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Modifying Data</b> </para> <ul> <li> <para> <i>PutItem</i> - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist. </para> </li> <li> <para> <i>UpdateItem</i> - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>DeleteItem</i> - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions. </para> </li> <li> <para> <i>BatchWriteItem</i> - Performs multiple <i>PutItem</i> and <i>DeleteItem</i> requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire <i>BatchWriteItem</i> operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB. </para> </li> </ul> <para> For conceptual information about modifying data, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> and <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html">Query and Scan Operations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes},Amazon.DynamoDBv2.ReturnConsumedCapacity)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <param name="returnConsumedCapacity">A property of BatchGetItemRequest used to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes})"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginBatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndBatchGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchGetItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}})"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="requestItems">A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following: <ul> <li> <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement: <ul> <li> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </li> </ul> </li> <li> <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement: <ul> <li> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </li> </ul> </li> </ul></param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem service method.</param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginBatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndBatchWriteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BatchWriteItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement},System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeDefinition},Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="attributeDefinitions">An array of attributes that describe the key schema for the table and indexes.</param> <param name="provisionedThroughput">A property of CreateTableRequest used to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginCreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndCreateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - The content of the old item is returned. </li> </ul></param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem service method.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginDeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndDeleteItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable(System.String)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="tableName"> The name of the table to delete.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable service method.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginDeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndDeleteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest)"> <summary> Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <i>DescribeLimits</i> API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para> <para> For example, you could use one of the AWS SDKs to do the following: </para> <ol> <li>Call <i>DescribeLimits</i> for a particular region to obtain your current account limits on provisioned capacity there.</li> <li>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</li> <li>Call <i>ListTables</i> to obtain a list of all your DynamoDB tables.</li> <li> <para> For each table name listed by <i>ListTables</i>, do the following: </para> <ul> <li>Call <i>DescribeTable</i> with the table name.</li> <li>Use the data returned by <i>DescribeTable</i> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</li> <li>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</li> </ul> </li> <li>Report the account limits for that region returned by <i>DescribeLimits</i>, along with the total current provisioned capacity levels you have calculated.</li> </ol> <para> This will let you see whether you are getting close to your account-level limits. </para> <para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para> <para> For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para> <note> <para> <i>DescribeLimits</i> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para> </note> <para> The <i>DescribeLimits</i> Request element has no content. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits service method.</param> <returns>The response from the DescribeLimits service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginDescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLimits operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.EndDescribeLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLimits.</param> <returns>Returns a DescribeLimitsResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable(System.String)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="tableName"> The name of the table to describe.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable service method.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginDescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndDescribeTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Boolean)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="consistentRead">Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetItem service method.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginGetItem(Amazon.DynamoDBv2.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndGetItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.String)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.String,System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="request">Container for the necessary parameters to execute the ListTables service method.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginListTables(Amazon.DynamoDBv2.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndListTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTables operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul></param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutItem service method.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginPutItem(Amazon.DynamoDBv2.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. </summary> <param name="request">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndPutItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PutItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> A <i>Query</i> operation uses the primary key of a table or a secondary index to directly access items from that table or index. <para> Use the <i>KeyConditionExpression</i> parameter to provide a specific value for the partition key. The <i>Query</i> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <i>Query</i> operation by specifying a sort key value and a comparison operator in <i>KeyConditionExpression</i>. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by sort key. </para> <para> Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </para> <para> If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <i>LastEvaluatedKey</i> element to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns both an empty result set and a <i>LastEvaluatedKey</i> value. <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used the <i>Limit</i> parameter. </para> <para> You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <i>ConsistentRead</i> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index. </para> </summary> <param name="request">Container for the necessary parameters to execute the Query service method.</param> <returns>The response from the Query service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginQuery(Amazon.DynamoDBv2.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. </summary> <param name="request">Container for the necessary parameters to execute the Query operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndQuery(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Query operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.List{System.String})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the Scan service method.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginScan(Amazon.DynamoDBv2.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. </summary> <param name="request">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndScan(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the Scan operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate})"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate},Amazon.DynamoDBv2.ReturnValue)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </li> <li> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </li> <li> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </li> </ul> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem service method.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginUpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndUpdateItem(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateItem operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable(System.String,Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="tableName">The name of the table to be updated.</param> <param name="provisionedThroughput">A property of UpdateTableRequest used to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDB.BeginUpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.IAmazonDynamoDB.EndUpdateTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Credentials and an AmazonDynamoDBClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.#ctor(System.String,System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBConfig)"> <summary> Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDynamoDBClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes},Amazon.DynamoDBv2.ReturnConsumedCapacity)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <param name="returnConsumedCapacity">A property of BatchGetItemRequest used to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes})"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest)"> <summary> The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem service method.</param> <returns>The response from the BatchGetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginBatchGetItem(Amazon.DynamoDBv2.Model.BatchGetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchGetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchGetItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchGetItem.</param> <returns>Returns a BatchGetItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}})"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="requestItems">A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following: <ul> <li> <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement: <ul> <li> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </li> </ul> </li> <li> <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement: <ul> <li> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </li> </ul> </li> </ul></param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest)"> <summary> The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem service method.</param> <returns>The response from the BatchWriteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginBatchWriteItem(Amazon.DynamoDBv2.Model.BatchWriteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BatchWriteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the BatchWriteItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBatchWriteItem.</param> <returns>Returns a BatchWriteItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement},System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeDefinition},Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="attributeDefinitions">An array of attributes that describe the key schema for the table and indexes.</param> <param name="provisionedThroughput">A property of CreateTableRequest used to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest)"> <summary> The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTable service method.</param> <returns>The response from the CreateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginCreateTable(Amazon.DynamoDBv2.Model.CreateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTable.</param> <returns>Returns a CreateTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - The content of the old item is returned. </li> </ul></param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest)"> <summary> Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem service method.</param> <returns>The response from the DeleteItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDeleteItem(Amazon.DynamoDBv2.Model.DeleteItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteItem operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteItem.</param> <returns>Returns a DeleteItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable(System.String)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="tableName"> The name of the table to delete.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest)"> <summary> The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable service method.</param> <returns>The response from the DeleteTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDeleteTable(Amazon.DynamoDBv2.Model.DeleteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTable.</param> <returns>Returns a DeleteTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest)"> <summary> Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <i>DescribeLimits</i> API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para> <para> For example, you could use one of the AWS SDKs to do the following: </para> <ol> <li>Call <i>DescribeLimits</i> for a particular region to obtain your current account limits on provisioned capacity there.</li> <li>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</li> <li>Call <i>ListTables</i> to obtain a list of all your DynamoDB tables.</li> <li> <para> For each table name listed by <i>ListTables</i>, do the following: </para> <ul> <li>Call <i>DescribeTable</i> with the table name.</li> <li>Use the data returned by <i>DescribeTable</i> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</li> <li>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</li> </ul> </li> <li>Report the account limits for that region returned by <i>DescribeLimits</i>, along with the total current provisioned capacity levels you have calculated.</li> </ol> <para> This will let you see whether you are getting close to your account-level limits. </para> <para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para> <para> For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para> <note> <para> <i>DescribeLimits</i> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para> </note> <para> The <i>DescribeLimits</i> Request element has no content. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits service method.</param> <returns>The response from the DescribeLimits service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDescribeLimits(Amazon.DynamoDBv2.Model.DescribeLimitsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeLimits operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeLimits operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLimits operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDescribeLimits(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeLimits operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeLimits.</param> <returns>Returns a DescribeLimitsResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable(System.String)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="tableName"> The name of the table to describe.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest)"> <summary> Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable service method.</param> <returns>The response from the DescribeTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginDescribeTable(Amazon.DynamoDBv2.Model.DescribeTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTable.</param> <returns>Returns a DescribeTableResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Boolean)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="consistentRead">Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem(Amazon.DynamoDBv2.Model.GetItemRequest)"> <summary> The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetItem service method.</param> <returns>The response from the GetItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginGetItem(Amazon.DynamoDBv2.Model.GetItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetItem operation. </summary> <param name="request">Container for the necessary parameters to execute the GetItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetItem.</param> <returns>Returns a GetItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.String)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.String,System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(System.Int32)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables(Amazon.DynamoDBv2.Model.ListTablesRequest)"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> <param name="request">Container for the necessary parameters to execute the ListTables service method.</param> <returns>The response from the ListTables service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginListTables(Amazon.DynamoDBv2.Model.ListTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTables operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTables operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTables.</param> <returns>Returns a ListTablesResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul></param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem(Amazon.DynamoDBv2.Model.PutItemRequest)"> <summary> Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PutItem service method.</param> <returns>The response from the PutItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginPutItem(Amazon.DynamoDBv2.Model.PutItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PutItem operation. </summary> <param name="request">Container for the necessary parameters to execute the PutItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPutItem.</param> <returns>Returns a PutItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Query(Amazon.DynamoDBv2.Model.QueryRequest)"> <summary> A <i>Query</i> operation uses the primary key of a table or a secondary index to directly access items from that table or index. <para> Use the <i>KeyConditionExpression</i> parameter to provide a specific value for the partition key. The <i>Query</i> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <i>Query</i> operation by specifying a sort key value and a comparison operator in <i>KeyConditionExpression</i>. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by sort key. </para> <para> Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </para> <para> If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <i>LastEvaluatedKey</i> element to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns both an empty result set and a <i>LastEvaluatedKey</i> value. <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used the <i>Limit</i> parameter. </para> <para> You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <i>ConsistentRead</i> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index. </para> </summary> <param name="request">Container for the necessary parameters to execute the Query service method.</param> <returns>The response from the Query service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginQuery(Amazon.DynamoDBv2.Model.QueryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Query operation. </summary> <param name="request">Container for the necessary parameters to execute the Query operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginQuery.</param> <returns>Returns a QueryResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.List{System.String})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.Condition})"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> <param name="attributesToGet"><important>This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.</param> <param name="scanFilter"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </important> A condition that evaluates the scan results and returns only the desired values. <note>This parameter does not support attributes of type List or Map.</note> If you specify more than one condition in the <i>ScanFilter</i> map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the <i>ConditionalOperator</i> parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: <ul> <li> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li><i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </li> </ul></param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan(Amazon.DynamoDBv2.Model.ScanRequest)"> <summary> The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the Scan service method.</param> <returns>The response from the Scan service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginScan(Amazon.DynamoDBv2.Model.ScanRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the Scan operation. </summary> <param name="request">Container for the necessary parameters to execute the Scan operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginScan.</param> <returns>Returns a ScanResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate})"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate},Amazon.DynamoDBv2.ReturnValue)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </li> <li> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </li> <li> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </li> </ul> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest)"> <summary> Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem service method.</param> <returns>The response from the UpdateItem service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> A condition specified in the operation could not be evaluated. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginUpdateItem(Amazon.DynamoDBv2.Model.UpdateItemRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateItem operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateItem operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateItem.</param> <returns>Returns a UpdateItemResult from DynamoDB.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable(System.String,Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="tableName">The name of the table to be updated.</param> <param name="provisionedThroughput">A property of UpdateTableRequest used to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest)"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable service method.</param> <returns>The response from the UpdateTable service method, as returned by DynamoDB.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10. <para> Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously. </para> <para> The total limit of tables in the <code>ACTIVE</code> state is 250. </para> </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the <code>CREATING</code> state. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBClient.BeginUpdateTable(Amazon.DynamoDBv2.Model.UpdateTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateTable operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateTable operation on AmazonDynamoDBClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateTable.</param> <returns>Returns a UpdateTableResult from DynamoDB.</returns> </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.AmazonDynamoDBStreamsClient"> <summary> Implementation for accessing DynamoDBStreams Amazon DynamoDB Streams <para> This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html">Amazon DynamoDB Developer Guide</a>. </para> <para> Note that this document is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/">Amazon DynamoDB API Reference</a> </para> </li> </ul> <para> The following are short descriptions of each low-level DynamoDB Streams API action, organized by function. </para> <ul> <li> <para> <i>DescribeStream</i> - Returns detailed information about a particular stream. </para> </li> <li> <para> <i>GetRecords</i> - Retrieves the stream records from within a shard. </para> </li> <li> <para> <i>GetShardIterator</i> - Returns information on how to retrieve the streams record from a shard with a given shard ID. </para> </li> <li> <para> <i>ListStreams</i> - Returns a list of all the streams associated with the current AWS account and endpoint. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.IAmazonDynamoDBStreams"> <summary> Interface for accessing DynamoDBStreams Amazon DynamoDB Streams <para> This is the Amazon DynamoDB Streams API Reference. This guide describes the low-level API actions for accessing streams and processing stream records. For information about application development with DynamoDB Streams, see the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide//Streams.html">Amazon DynamoDB Developer Guide</a>. </para> <para> Note that this document is intended for use with the following DynamoDB documentation: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/">Amazon DynamoDB Developer Guide</a> </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/">Amazon DynamoDB API Reference</a> </para> </li> </ul> <para> The following are short descriptions of each low-level DynamoDB Streams API action, organized by function. </para> <ul> <li> <para> <i>DescribeStream</i> - Returns detailed information about a particular stream. </para> </li> <li> <para> <i>GetRecords</i> - Retrieves the stream records from within a shard. </para> </li> <li> <para> <i>GetShardIterator</i> - Returns information on how to retrieve the streams record from a shard with a given shard ID. </para> </li> <li> <para> <i>ListStreams</i> - Returns a list of all the streams associated with the current AWS account and endpoint. </para> </li> </ul> </summary> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.DescribeStream(System.String)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="streamArn">The Amazon Resource Name (ARN) for the stream.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.DescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.BeginDescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStream operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.EndDescribeStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStream.</param> <returns>Returns a DescribeStreamResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetRecords(System.String)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="shardIterator">A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.BeginGetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRecords operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.EndGetRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRecords.</param> <returns>Returns a GetRecordsResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.GetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest)"> <summary> Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard. <note> <para> A shard iterator expires 15 minutes after it is returned to the requester. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.BeginGetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetShardIterator operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.EndGetShardIterator(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetShardIterator operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetShardIterator.</param> <returns>Returns a GetShardIteratorResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.ListStreams"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.ListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest)"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.BeginListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreams operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.IAmazonDynamoDBStreams.EndListStreams(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStreams operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStreams.</param> <returns>Returns a ListStreamsResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Credentials and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.#ctor(System.String,System.String,System.String,Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig)"> <summary> Constructs AmazonDynamoDBStreamsClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBStreamsClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonDynamoDBStreamsClient Configuration Object</param> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStream(System.String)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="streamArn">The Amazon Resource Name (ARN) for the stream.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.DescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest)"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream service method.</param> <returns>The response from the DescribeStream service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.BeginDescribeStream(Amazon.DynamoDBv2.Model.DescribeStreamRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeStream operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeStream operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStream operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.EndDescribeStream(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeStream operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeStream.</param> <returns>Returns a DescribeStreamResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetRecords(System.String)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="shardIterator">A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest)"> <summary> Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetRecords service method.</param> <returns>The response from the GetRecords service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.LimitExceededException"> Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries">Error Retries and Exponential Backoff</a> in the <i>Amazon DynamoDB Developer Guide</i>. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.BeginGetRecords(Amazon.DynamoDBv2.Model.GetRecordsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetRecords operation. </summary> <param name="request">Container for the necessary parameters to execute the GetRecords operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetRecords operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.EndGetRecords(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetRecords operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetRecords.</param> <returns>Returns a GetRecordsResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.GetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest)"> <summary> Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard. <note> <para> A shard iterator expires 15 minutes after it is returned to the requester. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator service method.</param> <returns>The response from the GetShardIterator service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> The operation attempted to read past the oldest stream record in a shard. <para> In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if: </para> <ul> <li>You request a shard iterator with a sequence number older than the trim point (24 hours).</li> <li>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</li> </ul> </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.BeginGetShardIterator(Amazon.DynamoDBv2.Model.GetShardIteratorRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetShardIterator operation. </summary> <param name="request">Container for the necessary parameters to execute the GetShardIterator operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetShardIterator operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.EndGetShardIterator(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetShardIterator operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetShardIterator.</param> <returns>Returns a GetShardIteratorResult from DynamoDBStreams.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.ListStreams"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.ListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest)"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ListStreams service method.</param> <returns>The response from the ListStreams service method, as returned by DynamoDBStreams.</returns> <exception cref="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> An error occurred on the server side. </exception> <exception cref="T:Amazon.DynamoDBv2.Model.ResourceNotFoundException"> The operation tried to access a nonexistent stream. </exception> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.BeginListStreams(Amazon.DynamoDBv2.Model.ListStreamsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListStreams operation. </summary> <param name="request">Container for the necessary parameters to execute the ListStreams operation on AmazonDynamoDBStreamsClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStreams operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsClient.EndListStreams(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListStreams operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListStreams.</param> <returns>Returns a ListStreamsResult from DynamoDBStreams.</returns> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig"> <summary> Configuration for accessing Amazon DynamoDBStreams service </summary> </member> <member name="M:Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.DynamoDBv2.AmazonDynamoDBStreamsConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="M:Amazon.DynamoDBv2.DynamoDBAsyncResult.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern </summary> <param name="disposing">Whether this object is being disposed via a call to Dispose or garbage collected.</param> </member> <member name="M:Amazon.DynamoDBv2.DynamoDBAsyncResult.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="T:Amazon.DynamoDBv2.AttributeAction"> <summary> Constants used for properties of type AttributeAction. </summary> </member> <member name="F:Amazon.DynamoDBv2.AttributeAction.ADD"> <summary> Constant ADD for AttributeAction </summary> </member> <member name="F:Amazon.DynamoDBv2.AttributeAction.DELETE"> <summary> Constant DELETE for AttributeAction </summary> </member> <member name="F:Amazon.DynamoDBv2.AttributeAction.PUT"> <summary> Constant PUT for AttributeAction </summary> </member> <member name="M:Amazon.DynamoDBv2.AttributeAction.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.AttributeAction.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ComparisonOperator"> <summary> Constants used for properties of type ComparisonOperator. </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.BEGINS_WITH"> <summary> Constant BEGINS_WITH for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.BETWEEN"> <summary> Constant BETWEEN for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.CONTAINS"> <summary> Constant CONTAINS for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.EQ"> <summary> Constant EQ for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.GE"> <summary> Constant GE for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.GT"> <summary> Constant GT for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.IN"> <summary> Constant IN for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.LE"> <summary> Constant LE for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.LT"> <summary> Constant LT for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.NE"> <summary> Constant NE for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.NOT_CONTAINS"> <summary> Constant NOT_CONTAINS for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.NOT_NULL"> <summary> Constant NOT_NULL for ComparisonOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ComparisonOperator.NULL"> <summary> Constant NULL for ComparisonOperator </summary> </member> <member name="M:Amazon.DynamoDBv2.ComparisonOperator.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ComparisonOperator.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ConditionalOperator"> <summary> Constants used for properties of type ConditionalOperator. </summary> </member> <member name="F:Amazon.DynamoDBv2.ConditionalOperator.AND"> <summary> Constant AND for ConditionalOperator </summary> </member> <member name="F:Amazon.DynamoDBv2.ConditionalOperator.OR"> <summary> Constant OR for ConditionalOperator </summary> </member> <member name="M:Amazon.DynamoDBv2.ConditionalOperator.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ConditionalOperator.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.IndexStatus"> <summary> Constants used for properties of type IndexStatus. </summary> </member> <member name="F:Amazon.DynamoDBv2.IndexStatus.ACTIVE"> <summary> Constant ACTIVE for IndexStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.IndexStatus.CREATING"> <summary> Constant CREATING for IndexStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.IndexStatus.DELETING"> <summary> Constant DELETING for IndexStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.IndexStatus.UPDATING"> <summary> Constant UPDATING for IndexStatus </summary> </member> <member name="M:Amazon.DynamoDBv2.IndexStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.IndexStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.KeyType"> <summary> Constants used for properties of type KeyType. </summary> </member> <member name="F:Amazon.DynamoDBv2.KeyType.HASH"> <summary> Constant HASH for KeyType </summary> </member> <member name="F:Amazon.DynamoDBv2.KeyType.RANGE"> <summary> Constant RANGE for KeyType </summary> </member> <member name="M:Amazon.DynamoDBv2.KeyType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.KeyType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ProjectionType"> <summary> Constants used for properties of type ProjectionType. </summary> </member> <member name="F:Amazon.DynamoDBv2.ProjectionType.ALL"> <summary> Constant ALL for ProjectionType </summary> </member> <member name="F:Amazon.DynamoDBv2.ProjectionType.INCLUDE"> <summary> Constant INCLUDE for ProjectionType </summary> </member> <member name="F:Amazon.DynamoDBv2.ProjectionType.KEYS_ONLY"> <summary> Constant KEYS_ONLY for ProjectionType </summary> </member> <member name="M:Amazon.DynamoDBv2.ProjectionType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ProjectionType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ReturnConsumedCapacity"> <summary> Constants used for properties of type ReturnConsumedCapacity. </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnConsumedCapacity.INDEXES"> <summary> Constant INDEXES for ReturnConsumedCapacity </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnConsumedCapacity.NONE"> <summary> Constant NONE for ReturnConsumedCapacity </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnConsumedCapacity.TOTAL"> <summary> Constant TOTAL for ReturnConsumedCapacity </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnConsumedCapacity.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnConsumedCapacity.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ReturnItemCollectionMetrics"> <summary> Constants used for properties of type ReturnItemCollectionMetrics. </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnItemCollectionMetrics.NONE"> <summary> Constant NONE for ReturnItemCollectionMetrics </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnItemCollectionMetrics.SIZE"> <summary> Constant SIZE for ReturnItemCollectionMetrics </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnItemCollectionMetrics.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnItemCollectionMetrics.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ReturnValue"> <summary> Constants used for properties of type ReturnValue. </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnValue.ALL_NEW"> <summary> Constant ALL_NEW for ReturnValue </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnValue.ALL_OLD"> <summary> Constant ALL_OLD for ReturnValue </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnValue.NONE"> <summary> Constant NONE for ReturnValue </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnValue.UPDATED_NEW"> <summary> Constant UPDATED_NEW for ReturnValue </summary> </member> <member name="F:Amazon.DynamoDBv2.ReturnValue.UPDATED_OLD"> <summary> Constant UPDATED_OLD for ReturnValue </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnValue.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ReturnValue.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ScalarAttributeType"> <summary> Constants used for properties of type ScalarAttributeType. </summary> </member> <member name="F:Amazon.DynamoDBv2.ScalarAttributeType.B"> <summary> Constant B for ScalarAttributeType </summary> </member> <member name="F:Amazon.DynamoDBv2.ScalarAttributeType.N"> <summary> Constant N for ScalarAttributeType </summary> </member> <member name="F:Amazon.DynamoDBv2.ScalarAttributeType.S"> <summary> Constant S for ScalarAttributeType </summary> </member> <member name="M:Amazon.DynamoDBv2.ScalarAttributeType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ScalarAttributeType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.Select"> <summary> Constants used for properties of type Select. </summary> </member> <member name="F:Amazon.DynamoDBv2.Select.ALL_ATTRIBUTES"> <summary> Constant ALL_ATTRIBUTES for Select </summary> </member> <member name="F:Amazon.DynamoDBv2.Select.ALL_PROJECTED_ATTRIBUTES"> <summary> Constant ALL_PROJECTED_ATTRIBUTES for Select </summary> </member> <member name="F:Amazon.DynamoDBv2.Select.COUNT"> <summary> Constant COUNT for Select </summary> </member> <member name="F:Amazon.DynamoDBv2.Select.SPECIFIC_ATTRIBUTES"> <summary> Constant SPECIFIC_ATTRIBUTES for Select </summary> </member> <member name="M:Amazon.DynamoDBv2.Select.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.Select.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.StreamViewType"> <summary> Constants used for properties of type StreamViewType. </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamViewType.KEYS_ONLY"> <summary> Constant KEYS_ONLY for StreamViewType </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamViewType.NEW_AND_OLD_IMAGES"> <summary> Constant NEW_AND_OLD_IMAGES for StreamViewType </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamViewType.NEW_IMAGE"> <summary> Constant NEW_IMAGE for StreamViewType </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamViewType.OLD_IMAGE"> <summary> Constant OLD_IMAGE for StreamViewType </summary> </member> <member name="M:Amazon.DynamoDBv2.StreamViewType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.StreamViewType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.TableStatus"> <summary> Constants used for properties of type TableStatus. </summary> </member> <member name="F:Amazon.DynamoDBv2.TableStatus.ACTIVE"> <summary> Constant ACTIVE for TableStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.TableStatus.CREATING"> <summary> Constant CREATING for TableStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.TableStatus.DELETING"> <summary> Constant DELETING for TableStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.TableStatus.UPDATING"> <summary> Constant UPDATING for TableStatus </summary> </member> <member name="M:Amazon.DynamoDBv2.TableStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.TableStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.OperationType"> <summary> Constants used for properties of type OperationType. </summary> </member> <member name="F:Amazon.DynamoDBv2.OperationType.INSERT"> <summary> Constant INSERT for OperationType </summary> </member> <member name="F:Amazon.DynamoDBv2.OperationType.MODIFY"> <summary> Constant MODIFY for OperationType </summary> </member> <member name="F:Amazon.DynamoDBv2.OperationType.REMOVE"> <summary> Constant REMOVE for OperationType </summary> </member> <member name="M:Amazon.DynamoDBv2.OperationType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.OperationType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ShardIteratorType"> <summary> Constants used for properties of type ShardIteratorType. </summary> </member> <member name="F:Amazon.DynamoDBv2.ShardIteratorType.AFTER_SEQUENCE_NUMBER"> <summary> Constant AFTER_SEQUENCE_NUMBER for ShardIteratorType </summary> </member> <member name="F:Amazon.DynamoDBv2.ShardIteratorType.AT_SEQUENCE_NUMBER"> <summary> Constant AT_SEQUENCE_NUMBER for ShardIteratorType </summary> </member> <member name="F:Amazon.DynamoDBv2.ShardIteratorType.LATEST"> <summary> Constant LATEST for ShardIteratorType </summary> </member> <member name="F:Amazon.DynamoDBv2.ShardIteratorType.TRIM_HORIZON"> <summary> Constant TRIM_HORIZON for ShardIteratorType </summary> </member> <member name="M:Amazon.DynamoDBv2.ShardIteratorType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.ShardIteratorType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.StreamStatus"> <summary> Constants used for properties of type StreamStatus. </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamStatus.DISABLED"> <summary> Constant DISABLED for StreamStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamStatus.DISABLING"> <summary> Constant DISABLING for StreamStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamStatus.ENABLED"> <summary> Constant ENABLED for StreamStatus </summary> </member> <member name="F:Amazon.DynamoDBv2.StreamStatus.ENABLING"> <summary> Constant ENABLING for StreamStatus </summary> </member> <member name="M:Amazon.DynamoDBv2.StreamStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.DynamoDBv2.StreamStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.DynamoDBv2.ConversionSchema"> <summary> Available conversion schemas. </summary> </member> <member name="F:Amazon.DynamoDBv2.ConversionSchema.V1"> <summary> Default schema before 2014 L, M, BOOL, NULL support The following .NET types are converted into the following DynamoDB types: Number types (byte, int, float, decimal, etc.) are converted to N String and char are converted to S Bool is converted to N (0=false, 1=true) DateTime and Guid are converto to S MemoryStream and byte[] are converted to B List, HashSet, and array of numerics types are converted to NS List, HashSet, and array of string-based types are converted to SS List, HashSet, and array of binary-based types are converted to BS Dictionary{string,object} are converted to M </summary> </member> <member name="F:Amazon.DynamoDBv2.ConversionSchema.V2"> <summary> Schema fully supporting 2014 L, M, BOOL, NULL additions The following .NET types are converted into the following DynamoDB types: Number types (byte, int, float, decimal, etc.) are converted to N String and char are converted to S Bool is converted to BOOL DateTime and Guid are converto to S MemoryStream and byte[] are converted to B HashSet of numerics types are converted to NS HashSet of string-based types are converted to SS HashSet of binary-based types are converted to BS List and array of numerics, string-based types, and binary-based types are converted to L type. Dictionary{string,object} are converted to M </summary> </member> <member name="T:Amazon.DynamoDBv2.DynamoDBEntryConversion"> <summary> A collection of converters capable of converting between .NET and DynamoDB objects. </summary> </member> <member name="M:Amazon.DynamoDBv2.DynamoDBEntryConversion.GetConversion(Amazon.DynamoDBv2.ConversionSchema)"> <summary> Returns a DynamoDBEntryConversion corresponding to the ConversionSchema. The returned conversion is immutable. The conversion must be cloned before it can be modified. </summary> <param name="schema">Conversion to return.</param> <returns>DynamoDBEntryConversion corresponding to the ConversionSchema.</returns> </member> <member name="M:Amazon.DynamoDBv2.DynamoDBEntryConversion.#ctor"> <summary> Creates an empty, mutable conversion. </summary> </member> <member name="P:Amazon.DynamoDBv2.DynamoDBEntryConversion.V1"> <summary> Default conversion before 2014 L, M, BOOL, NULL support. The following .NET types are converted into the following DynamoDB types: Number types (byte, int, float, decimal, etc.) are converted to N String and char are converted to S Bool is converted to N (0=false, 1=true) DateTime and Guid are converto to S MemoryStream and byte[] are converted to B List, HashSet, and array of numerics types are converted to NS List, HashSet, and array of string-based types are converted to SS List, HashSet, and array of binary-based types are converted to BS Dictionary{string,object} are converted to M </summary> </member> <member name="P:Amazon.DynamoDBv2.DynamoDBEntryConversion.V2"> <summary> Schema fully supporting 2014 L, M, BOOL, NULL additions. The following .NET types are converted into the following DynamoDB types: Number types (byte, int, float, decimal, etc.) are converted to N String and char are converted to S Bool is converted to BOOL DateTime and Guid are converto to S MemoryStream and byte[] are converted to B HashSet of numerics types are converted to NS HashSet of string-based types are converted to SS HashSet of binary-based types are converted to BS List and array of numerics, string-based types, and binary-based types are converted to L type. Dictionary{string,object} are converted to M </summary> </member> <member name="P:Amazon.DynamoDBv2.DynamoDBEntryConversion.CurrentConversion"> <summary> Conversion corresponding to AWSConfigs.DynamoDBConfig.ConversionSchema </summary> </member> <member name="M:Amazon.DynamoDBv2.Converter.GetTargetTypes"> <summary> Returns all types for which it can be used. </summary> <returns></returns> </member> <member name="P:Amazon.DynamoDBv2.Converter.Conversion"> <summary> Conversion that this converter is part of. This field is set by DynamoDBEntryConversion when the Converter is added to that DynamoDBEntryConversion. This conversion should be used if the Converter needs to make sub-conversions (for instance, a collection converter). </summary> </member> <member name="T:Amazon.DynamoDBv2.BoolConverterV1"> <summary> A boolean converter which reads booleans as N or BOOL types, but writes out N type (1 if true, 0 if false). </summary> </member> <member name="T:Amazon.DynamoDBv2.PrimitiveCollectionConverterV1"> <summary> A collection converter which reads both sets of collections (sets and lists) and writes out sets (NS, SS, BS) </summary> </member> <member name="T:Amazon.DynamoDBv2.DictionaryConverterV1"> <summary> Dictionary converter. Converts from Dictionary{string,object} to DynamoDBEntry. Does NOT convert from DynamoDBEntry to Dictionary{string,object}. </summary> </member> <member name="T:Amazon.DynamoDBv2.BoolConverterV2"> <summary> A boolean converter which reads booleans as N or BOOL types, but writes out BOOL type. </summary> </member> <member name="T:Amazon.DynamoDBv2.CollectionConverterV2"> <summary> A collection converter which reads both sets of collections (sets and lists) but writes out different types depending on input: HashSet input - converts to a DynamoDB set (NS, SS, BS) Any other IEnumerable input - converts to a DynamoDB list (L) </summary> </member> <member name="M:Amazon.DynamoDBv2.CollectionConverterV2.TryTo(System.Object,Amazon.DynamoDBv2.DocumentModel.PrimitiveList@)"> <summary> If value is HashSet{T}, converts the items to PrimitiveList </summary> <param name="value"></param> <param name="pl"></param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.CollectionConverterV2.TryTo(System.Object,Amazon.DynamoDBv2.DocumentModel.DynamoDBList@)"> <summary> If value implements IEnumerable{T}, converts the items to DynamoDBList This method is called after the PrimitiveList version of TryTo, so this will never work on a HashSet{T}. </summary> <param name="value"></param> <param name="l"></param> <returns></returns> </member> <member name="T:Amazon.DynamoDBv2.SetPropertyConverter`2"> <summary> Class that implements IPropertyConverter to convert collections to PrimitiveList types, which are then stored as sets (NS, SS, BS) in DynamoDB. Use this converter to bypass the default schema behavior for a particular property. The Conversion property can be customized in the constructor of a subclass to use a different conversion scheme for converting individual elements. The default value for this field is the standard V1 conversion. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.IPropertyConverter"> <summary> Interface for converting arbitrary objects to DynamoDB-supported object types. Implementing type must be public, instantiable, and should have a zero-parameter constructor. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IPropertyConverter.ToEntry(System.Object)"> <summary> Convert object to DynamoDBEntry </summary> <param name="value">Object to be deserialized</param> <returns>Object deserialized as DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IPropertyConverter.FromEntry(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)"> <summary> Convert DynamoDBEntry to the specified object </summary> <param name="entry">DynamoDBEntry to be serialized</param> <returns>Serialized object</returns> </member> <member name="T:Amazon.DynamoDBv2.ListToSetPropertyConverter`1"> <summary> Class that implements IPropertyConverter to convert collections to PrimitiveList types, which are then stored as sets (NS, SS, BS) in DynamoDB. This converter assumes that the target is of type List{TElement}. Use this converter to bypass the default schema behavior for a particular property. The Conversion property can be customized in the constructor of a subclass to use a different conversion scheme for converting individual elements. The default value for this field is the standard V1 conversion. </summary> <typeparam name="TElement"></typeparam> </member> <member name="T:Amazon.DynamoDBv2.BoolAsNConverter"> <summary> Class that implements IPropertyConverter to convert bool/Boolean .NET types to DynamoDB numeric (N) type, where true is stored as N:1, false as N:0. Use this converter to bypass the default schema behavior for a particular property. </summary> </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="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> PrimitiveList if DynamoDBEntry is of PrimitiveList type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDynamoDBList"> <summary> Convert DynamoDBEntry to DynamoDBList </summary> <returns> DynamoDBList if DynamoDBEntry is of DynamoDBList type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDynamoDBBool"> <summary> Convert DynamoDBEntry to DynamoDBBool </summary> <returns> DynamoDBBool if DynamoDBEntry is of DynamoDBBool type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDynamoDBNull"> <summary> Convert DynamoDBEntry to DynamoDBNull </summary> <returns> DynamoDBNull if DynamoDBEntry is of DynamoDBNull type; otherwise null </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsDocument"> <summary> Convert DynamoDBEntry to Document </summary> <returns> Document if DynamoDBEntry is of Document 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.AsArrayOfDynamoDBEntry"> <summary> Explicitly convert DynamoDBEntry to DynamoDBEntry[] </summary> <returns>DynamoDBEntry[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfDynamoDBEntry"> <summary> Explicitly convert DynamoDBEntry to List<DynamoDBEntry> </summary> <returns>List<DynamoDBEntry> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsHashSetOfDynamoDBEntry"> <summary> Explicitly convert DynamoDBEntry to HashSet<DynamoDBEntry> </summary> <returns>HashSet<DynamoDBEntry> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsArrayOfPrimitive"> <summary> Explicitly convert DynamoDBEntry to Primitive[] </summary> <returns>Primitive[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(Amazon.DynamoDBv2.DocumentModel.Primitive[])~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert Primitive[] to DynamoDBEntry </summary> <param name="data">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)~Amazon.DynamoDBv2.DocumentModel.Primitive[]"> <summary> Explicitly convert DynamoDBEntry to Primitive[] </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Primitive[] value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfPrimitive"> <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.AsHashSetOfPrimitive"> <summary> Explicitly convert DynamoDBEntry to HashSet<Primitive> </summary> <returns>HashSet<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.HashSet{Amazon.DynamoDBv2.DocumentModel.Primitive})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert HashSet<Primitive> to DynamoDBEntry </summary> <param name="data">HashSet<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.HashSet{Amazon.DynamoDBv2.DocumentModel.Primitive}"> <summary> Explicitly convert DynamoDBEntry to HashSet<Primitive> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>HashSet<Primitive> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsListOfDocument"> <summary> Explicitly convert DynamoDBEntry to List<Document> </summary> <returns>List<Document> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Document})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert List<Document> to DynamoDBEntry </summary> <param name="data">List<Document> 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.Document}"> <summary> Explicitly convert DynamoDBEntry to List<Document> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<Document> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsArrayOfString"> <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_Explicit(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.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.AsHashSetOfString"> <summary> Explicitly convert DynamoDBEntry to HashSet<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.HashSet{System.String})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert HashSet<String> to DynamoDBEntry </summary> <param name="data">HashSet<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.HashSet{System.String}"> <summary> Explicitly convert DynamoDBEntry to HashSet<String> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>HashSet<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.AsHashSetOfByteArray"> <summary> Explicitly convert DynamoDBEntry to HashSet<byte[]> </summary> <returns>HashSet<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.HashSet{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert HashSet<byte[]> to DynamoDBEntry </summary> <param name="data">HashSet<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.HashSet{System.Byte[]}"> <summary> Explicitly convert DynamoDBEntry to HashSet<byte[]> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>HashSet<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="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.AsHashSetOfMemoryStream"> <summary> Explicitly convert DynamoDBEntry to HashSet<MemoryStream> </summary> <returns>HashSet<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry.op_Implicit(System.Collections.Generic.HashSet{System.IO.MemoryStream})~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry"> <summary> Implicitly convert HashSet<MemoryStream> to DynamoDBEntry </summary> <param name="data">HashSet<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.HashSet{System.IO.MemoryStream}"> <summary> Explicitly convert DynamoDBEntry to HashSet<MemoryStream> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>HashSet<MemoryStream> value of DynamoDBEntry</returns> </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.ForceConversion(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Returns a new instance of Document where all unconverted .NET types are converted to DynamoDBEntry types using a specific conversion. </summary> <param name="conversion"></param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToJson"> <summary> <para> Converts the current Document into a matching JSON string. </para> <para> DynamoDB types are a superset of JSON types, thus the following DynamoDB cannot be properly represented as JSON data: PrimitiveList (SS, NS, BS types) - these sets will be converted to JSON arrays Binary Primitive (B type) - binary data will be converted to Base64 strings </para> <para> If the resultant JSON is passed to Document.FromJson, the binary values will be treated as Base64 strings. Invoke Document.DecodeBase64Attributes to decode these strings into binary data. </para> </summary> <returns>JSON string corresponding to the current Document.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToJsonPretty"> <summary> <para> Converts the current Document into a matching pretty JSON string. </para> <para> DynamoDB types are a superset of JSON types, thus the following DynamoDB cannot be properly represented as JSON data: PrimitiveList (SS, NS, BS types) - these sets will be converted to JSON arrays Binary Primitive (B type) - binary data will be converted to Base64 strings </para> <para> If the resultant JSON is passed to Document.FromJson, the binary values will be treated as Base64 strings. Invoke Document.DecodeBase64Attributes to decode these strings into binary data. </para> </summary> <returns>JSON string corresponding to the current Document.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToAttributeMap"> <summary> Creates a map of attribute names mapped to AttributeValue objects. Converts .NET types using the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Document.ToAttributeMap(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Creates a map of attribute names mapped to AttributeValue objects. </summary> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <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.ToExpectedAttributeMap(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Creates a map of attribute names mapped to ExpectedAttributeValue objects. </summary> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <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.ToAttributeUpdateMap(Amazon.DynamoDBv2.DynamoDBEntryConversion,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> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</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.DecodeBase64Attributes(System.String[])"> <summary> <para> Decodes root-level Base64-encoded strings to their binary representations. Use this method if the Document was constructed from JSON that contains base64-encoded binary values, which result from calling ToJson on a Document with binary data. </para> <para> Individual strings become binary data. List and sets of Base64-encoded strings become lists and sets of binary data. </para> </summary> <param name="attributeNames">Names of root-level attributes to decode.</param> </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="M:Amazon.DynamoDBv2.DocumentModel.Document.FromJson(System.String)"> <summary> Creates a document from a JSON string. The conversion is as follows: Objects are converted to DynamoDB M types. Arrays are converted to DynamoDB L types. Boolean types are converted to DynamoDB BOOL types. Null values are converted to DynamoDB NULL types. Numerics are converted to DynamoDB N types. Strings are converted to DynamoDB S types. </summary> <param name="json">JSON string.</param> <returns>Document representing the JSON 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> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> <summary> Class for retrieving a batch of Documents from a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.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="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="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.AttributesToGet"> <summary> List of attributes to retrieve. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DocumentBatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet"> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> <summary> Class for retrieving a batch of Documents from multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchGet.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="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="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> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> <summary> Class for putting and/or deleting a batch of items in a single DynamoDB table. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DocumentBatchWrite.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="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="T:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite"> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> <summary> Class for putting and/or deleting a batch of items in multiple DynamoDB tables. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.MultiTableDocumentBatchWrite.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="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="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.DynamoDBBool"> <summary> A DynamoDBEntry that represents a DynamoDB bool (BOOL) type. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBBool.AsBoolean"> <summary> Explicitly convert DynamoDBBool to Boolean </summary> <returns>Boolean value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBBool.op_Implicit(System.Boolean)~Amazon.DynamoDBv2.DocumentModel.DynamoDBBool"> <summary> Implicitly convert Boolean to DynamoDBBool </summary> <param name="data">Boolean data to convert</param> <returns>DynamoDBBool representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBBool.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBBool)~System.Boolean"> <summary> Explicitly convert DynamoDBBool to Boolean </summary> <param name="p">DynamoDBBool to convert</param> <returns>Boolean value of DynamoDBBool</returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.UnconvertedDynamoDBEntry"> <summary> A DynamoDBEntry holding an unconverted object. The entry is converted to a converted DynamoDBEntry either by the consuming Document or Table. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> A DynamoDBEntry that represents a DynamoDB list (L) type. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.#ctor"> <summary> Constructs an empty DynamoDBList. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.Add(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry)"> <summary> Adds a DynamoDB to the end of the list. </summary> <param name="value">DynamoDB to add.</param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.ForceConversion(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Returns a new instance of Document where all unconverted .NET types are converted to DynamoDBEntry types using a specific conversion. </summary> <param name="conversion"></param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsArrayOfDynamoDBEntry"> <summary> Explicitly convert DynamoDBList to DynamoDBEntry[] </summary> <returns>DynamoDBEntry[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[])~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert DynamoDBEntry[] to DynamoDBList </summary> <param name="data">DynamoDBEntry[] data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry[]"> <summary> Explicitly convert DynamoDBList to DynamoDBEntry[] </summary> <param name="p">DynamoDBList to convert</param> <returns>DynamoDBEntry[] value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsListOfDynamoDBEntry"> <summary> Explicitly convert DynamoDBList to List<DynamoDBEntry> </summary> <returns>List<DynamoDBEntry> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert List<DynamoDBEntry> to DynamoDBList </summary> <param name="data">List<DynamoDBEntry> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry}"> <summary> Explicitly convert DynamoDBList to List<DynamoDBEntry> </summary> <param name="p">DynamoDBList to convert</param> <returns>List<DynamoDBEntry> value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsListOfDocument"> <summary> Explicitly convert DynamoDBList to List<Document> </summary> <returns>List<Document> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Document})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert List<Document> to DynamoDBEntry </summary> <param name="data">List<Document> data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.List{Amazon.DynamoDBv2.DocumentModel.Document}"> <summary> Explicitly convert DynamoDBEntry to List<Document> </summary> <param name="p">DynamoDBEntry to convert</param> <returns>List<Document> value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsArrayOfString"> <summary> Explicitly convert DynamoDBEntry to String[] </summary> <returns>String[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.String[])~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <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.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~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.DynamoDBList.AsListOfString"> <summary> Explicitly convert DynamoDBList to List<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.List{System.String})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert List<String> to DynamoDBList </summary> <param name="data">List<String> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.List{System.String}"> <summary> Explicitly convert DynamoDBList to List<String> </summary> <param name="p">DynamoDBList to convert</param> <returns>List<String> value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsHashSetOfString"> <summary> Explicitly convert DynamoDBEntry to HashSet<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.HashSet{System.String})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert HashSet<String> to DynamoDBList </summary> <param name="data">HashSet<String> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.HashSet{System.String}"> <summary> Explicitly convert DynamoDBList to HashSet<String> </summary> <param name="p">DynamoDBList to convert</param> <returns>HashSet<String> value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsListOfByteArray"> <summary> Explicitly convert DynamoDBList to byte[] </summary> <returns>List<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.List{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert List<byte[]> to DynamoDBList </summary> <param name="data">List<byte[]> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.List{System.Byte[]}"> <summary> Explicitly convert DynamoDBList to List<byte[]> </summary> <param name="p">DynamoDBList to convert</param> <returns>List<byte[]> value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsHashSetOfByteArray"> <summary> Explicitly convert DynamoDBList to HashSet<byte[]> </summary> <returns>HashSet<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.HashSet{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert HashSet<byte[]> to DynamoDBList </summary> <param name="data">HashSet<byte[]> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.HashSet{System.Byte[]}"> <summary> Explicitly convert DynamoDBList to HashSet<byte[]> </summary> <param name="p">DynamoDBList to convert</param> <returns>HashSet<byte[]> value of DynamoDBList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.AsListOfMemoryStream"> <summary> Explicitly convert DynamoDBList to List<MemoryStream> </summary> <returns>List<MemoryStream> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Implicit(System.Collections.Generic.List{System.IO.MemoryStream})~Amazon.DynamoDBv2.DocumentModel.DynamoDBList"> <summary> Implicitly convert List<MemoryStream> to DynamoDBList </summary> <param name="data">List<MemoryStream> data to convert</param> <returns>DynamoDBList representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.DynamoDBList)~System.Collections.Generic.List{System.IO.MemoryStream}"> <summary> Explicitly convert DynamoDBList to List<MemoryStream> </summary> <param name="p">DynamoDBList to convert</param> <returns>List<MemoryStream> value of DynamoDBList</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.Entries"> <summary> Collection of DynamoDB entries </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DynamoDBList.Item(System.Int32)"> <summary> Gets or sets DynamoDB at a specific location in the list. </summary> <param name="i">Index of the DynamoDB in question.</param> <returns>DynamoDB in question.</returns> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DynamoDBNull"> <summary> A DynamoDBEntry that represents a DynamoDB null (NULL) type. </summary> </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 This call will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema </summary> <returns>Amazon.DynamoDBv2.Model.ExpectedAttributeValue</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedValue.ToExpectedAttributeValue(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Converts this ExpectedValue instance to Amazon.DynamoDBv2.Model.ExpectedAttributeValue </summary> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <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. This call will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema </summary> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.ExpectedState.ToExpectedAttributeMap(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Creates a map of attribute names mapped to ExpectedAttributeValue objects. </summary> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <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.Expression"> <summary> Expressions are used for conditional deletes and filtering for query and scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Expression.ExpressionStatement"> <summary> Gets and sets the property ExpressionStatement. "Price > :price" is an example expression statement. :price is a variable which gets its value from the ExpressionAttributeValues collection. If this is used for deletes then it prevents the delete from happening if the Price attribute on the item is less then the passed in price. For query and scan it will only return back items where the Price attribute is greater then passed in price. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Expression.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. This collection contains attribute names from the item that should be substituted in the expression when it is evaluated. For example the expression "#C < #U" will expect the attribute names to be added to this collection. <code> expression.ExpressionAttributeNames["#C"] = "CriticRating" expression.ExpressionAttributeNames["#U"] = "UserRating" </code> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Expression.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. This collection contains the values to be substituted in the expression. For example the expression "Price > :price" will contain one entry in this collection a key of ":price". <para> DynamoDBEntry contains many common implicit cast operations so assignment can be done with the basic .NET types. In the price example shown above the value to be used for the expression can be provided using the following code snippet: <code> expression.ExpressionAttributeNames[":price"] = 3.99; </code> </para> </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 This call will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema </summary> <returns>Map from attribute name to condition</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Filter.ToConditions(Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Converts filter to a map of conditions </summary> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <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.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.JsonUtils"> <summary> Utility methods to handle conversion from/to JSON </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.JsonUtils.FromJson(System.String)"> <summary> Parses JSON text to produce Document. </summary> <param name="jsonText"></param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.JsonUtils.ToJson(Amazon.DynamoDBv2.DocumentModel.Document,System.Boolean)"> <summary> Creates JSON text for a given Document </summary> <param name="document"></param> <param name="prettyPrint"></param> <returns></returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.JsonUtils.DecodeBase64Attributes(Amazon.DynamoDBv2.DocumentModel.Document,System.String[])"> <summary> Decodes specific attributes from base64 to their binary representation. </summary> <param name="document"></param> <param name="attributeNames"></param> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.DynamoDBEntryType"> <summary> Enumerator describing type of DynamoDB data in a Primitive or PrimitiveList </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.Primitive"> <summary> A DynamoDBEntry that represents a scalar 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.AsArrayOfPrimitive"> <summary> Explicitly convert DynamoDBEntry to Primitive[] </summary> <returns>Primitive[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(Amazon.DynamoDBv2.DocumentModel.Primitive[])~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert Primitive[] to DynamoDBEntry </summary> <param name="data">Primitive[] data to convert</param> <returns>DynamoDBEntry representing the data</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~Amazon.DynamoDBv2.DocumentModel.Primitive[]"> <summary> Explicitly convert DynamoDBEntry to Primitive[] </summary> <param name="p">DynamoDBEntry to convert</param> <returns>Primitive[] value of DynamoDBEntry</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsListOfPrimitive"> <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.AsHashSetOfPrimitive"> <summary> Explicitly convert PrimitiveList to HashSet<Primitive> </summary> <returns>HashSet<Primitive> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.HashSet{Amazon.DynamoDBv2.DocumentModel.Primitive})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert HashSet<Primitive> to PrimitiveList </summary> <param name="data">HashSet<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.HashSet{Amazon.DynamoDBv2.DocumentModel.Primitive}"> <summary> Explicitly convert PrimitiveList to HashSet<Primitive> </summary> <param name="p">PrimitiveList to convert</param> <returns>HashSet<Primitive> value of PrimitiveList</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.AsArrayOfString"> <summary> Explicitly convert DynamoDBEntry to String[] </summary> <returns>String[] value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.String[])~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <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.PrimitiveList.op_Explicit(Amazon.DynamoDBv2.DocumentModel.PrimitiveList)~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.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.AsHashSetOfString"> <summary> Explicitly convert DynamoDBEntry to HashSet<String> </summary> <returns>List<String> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.HashSet{System.String})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert HashSet<String> to PrimitiveList </summary> <param name="data">HashSet<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.HashSet{System.String}"> <summary> Explicitly convert PrimitiveList to HashSet<String> </summary> <param name="p">PrimitiveList to convert</param> <returns>HashSet<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.AsHashSetOfByteArray"> <summary> Explicitly convert PrimitiveList to HashSet<byte[]> </summary> <returns>HashSet<byte[]> value of this object</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.PrimitiveList.op_Implicit(System.Collections.Generic.HashSet{System.Byte[]})~Amazon.DynamoDBv2.DocumentModel.PrimitiveList"> <summary> Implicitly convert HashSet<byte[]> to PrimitiveList </summary> <param name="data">HashSet<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.HashSet{System.Byte[]}"> <summary> Explicitly convert PrimitiveList to HashSet<byte[]> </summary> <param name="p">PrimitiveList to convert</param> <returns>HashSet<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> <summary> Search response object </summary> <summary> Search response object </summary> </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="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="P:Amazon.DynamoDBv2.DocumentModel.Search.TableName"> <summary> Name of the table being searched </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.CollectResults"> <summary> Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Limit"> <summary> Upper limit on the number of items returned. For Queries: upper limit on the number of items returned. For Scan: limit on the number of items scanned. Maps directly to Limit property on Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.KeyExpression"> <summary> The key expression that is evaluated for each item of a query. This applies only to Query operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.FilterExpression"> <summary> The filter expression that is evaluated for each item. This applies to Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Filter"> <summary> Filter for the search operation This applies to Query and Scan operations. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.ConditionalOperator"> <summary> Conditional operator for the search operation </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.AttributesToGet"> <summary> List of attribute names to retrieve </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsConsistentRead"> <summary> Flag that, if true, indicates that the search is operating in consistent-read mode </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsBackwardSearch"> <summary> Flag that, if true, indicates that the search is traversing backwards </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IsDone"> <summary> Flag that, if true, indicates that the search is done </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.NextKey"> <summary> Key denoting the starting point of the next set of results </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Matches"> <summary> List of currently found items </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.TotalSegments"> <summary> For parallel <i>Scan</i> requests, <i>TotalSegments</i>represents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the <i>Scan</i> request. The value of <i>TotalSegments</i> corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel <i>Scan</i>. For example, if you want to scan a table using four application threads, you would specify a <i>TotalSegments</i> value of 4. The value for <i>TotalSegments</i> must be greater than or equal to 1, and less than or equal to 4096. If you specify a <i>TotalSegments</i> value of 1, the <i>Scan</i> will be sequential rather than parallel. If you specify <i>TotalSegments</i>, you must also specify <i>Segment</i>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>1 - 4096</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Segment"> <summary> For parallel <i>Scan</i> requests, <i>Segment</i> identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a <i>Scan</i> request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a <i>Segment</i> value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for <i>Segment</i> must be less than or equal to 0, and less than the value provided for <i>TotalSegments</i>. If you specify <i>Segment</i>, you must also specify <i>TotalSegments</i>. <para> <b>Constraints:</b> <list type="definition"> <item> <term>Range</term> <description>0 - 4095</description> </item> </list> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Count"> <summary> Gets the total number of items that match the search parameters. If IsDone is true and CollectResults is true, returns Matches.Count. Otherwise, makes a call to DynamoDB to find out the number of matching items, without retrieving the items. Count is then cached. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.IndexName"> <summary> Name of the index to query or scan against. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Search.Select"> <summary> Enum specifying what data to return from query. </summary> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.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.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.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.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.ValidateConditional(Amazon.DynamoDBv2.DocumentModel.IConditionalOperationConfig)"> <summary> Validates that the conditional properties on the config object are correctly set. </summary> <exception cref="T:System.InvalidOperationException"/> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.LoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will throw an exception if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.LoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DynamoDBEntryConversion)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <returns>Table object representing the specified table.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryLoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DocumentModel.Table@)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will return false if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="table">Loaded table.</param> <returns> True if table was successfully loaded; otherwise false. </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryLoadTable(Amazon.DynamoDBv2.IAmazonDynamoDB,System.String,Amazon.DynamoDBv2.DynamoDBEntryConversion,Amazon.DynamoDBv2.DocumentModel.Table@)"> <summary> Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. </summary> <param name="ddbClient">Client to use to access DynamoDB.</param> <param name="tableName">Name of the table.</param> <param name="conversion">Conversion to use for converting .NET values to DynamoDB values.</param> <param name="table">Loaded table.</param> <returns> True if table was successfully loaded; otherwise false. </returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.ScanFilter)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used. </summary> <param name="filter">Filter to apply to the scan.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.Expression)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used. </summary> <param name="filterExpression">Expression to apply to the scan.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Scan(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig)"> <summary> Initiates a Search object to Scan a DynamoDB table, with the specified config. No calls are made until the Search object is used. </summary> <param name="config">Configuration to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.QueryFilter)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter. No calls are made until the Search object is used. </summary> <param name="hashKey">Value of the hash key for the query operation.</param> <param name="filter">Filter to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Expression)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and expression. No calls are made until the Search object is used. </summary> <param name="hashKey">Value of the hash key for the query operation.</param> <param name="filterExpression">Expression to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.QueryFilter)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified filter. No calls are made until the Search object is used. </summary> <param name="filter">Filter to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.Query(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig)"> <summary> Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used. </summary> <param name="config">Configuration to use.</param> <returns>Resultant Search container.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.CreateBatchGet"> <summary> Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB. </summary> <returns>Empty DocumentBatchGet object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.CreateBatchWrite"> <summary> Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB. </summary> <returns>Empty DocumentBatchWrite object.</returns> </member> <member name="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.TryPutItem(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>True if put was successful or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.GetItem(Amazon.DynamoDBv2.DocumentModel.Primitive)"> <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.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.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, using specified config. </summary> <param name="doc">Document to update.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or updated attributes, depending on config.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryUpdateItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig)"> <summary> Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. </summary> <param name="doc">Attributes to update.</param> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if updated or false if the condition in the config was not met.</returns> <seealso cref="T:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig"/> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Document)"> <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> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, using specified configs. </summary> <param name="document">Document to delete.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a hash primary key, using specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a hash primary key, using specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.Primitive,Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. </summary> <param name="hashKey">Hash key element of the document.</param> <param name="rangeKey">Range key element of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a key, using specified configs. </summary> <exception cref="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException">If the condition set on the config fails.</exception> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>Null or old attributes, depending on config.</returns> </member> <member name="M:Amazon.DynamoDBv2.DocumentModel.Table.TryDeleteItem(System.Collections.Generic.IDictionary{System.String,Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry},Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig)"> <summary> Delete a document in DynamoDB, identified by a key, using specified configs. </summary> <param name="key">Key of the document.</param> <param name="config">Configuration to use.</param> <returns>True if deleted or false if the condition in the config was not met.</returns> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.TableName"> <summary> Name of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.Keys"> <summary> Keys of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.GlobalSecondaryIndexes"> <summary> Global secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.LocalSecondaryIndexes"> <summary> Local secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.LocalSecondaryIndexNames"> <summary> Names of the local secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.GlobalSecondaryIndexNames"> <summary> Names of the global secondary indexes of the table. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.HashKeys"> <summary> List of keys on the table marked HASH </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.RangeKeys"> <summary> List of keys on the table marked RANGE </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.Table.Attributes"> <summary> List of key attributes on the table. </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig"> <summary> Configuration for the Table.PutItem operation </summary> </member> <member name="T:Amazon.DynamoDBv2.DocumentModel.IConditionalOperationConfig"> <summary> Interface for operations that support conditional behavior. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.IConditionalOperationConfig.ConditionalExpression"> <summary> An expression that is evaluated before the operation. If the expression evaluates to false then the operation will fail with a ConditionalCheckFailedException exception. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.IConditionalOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. 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.IConditionalOperationConfig.Expected"> <summary> Document representing the expected state of data in DynamoDB. 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.ConditionalExpression"> <summary> The expression that is evaluated before the put is performed. If the expression evaluates to false the put will fail and a ConditionalCheckFailedException exception will be thrown. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.PutItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. 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. 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.ConditionalExpression"> <summary> The expression that is evaluated before the update is performed. If the expression evaluates to false the update will fail and a ConditionalCheckFailedException exception will be thrown. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.UpdateItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. 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. 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.ConditionalExpression"> <summary> The expression that is evaluated before the delete is performed. If the expression evaluates to false the delete will fail and a ConditionalCheckFailedException exception will be thrown. </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.DeleteItemOperationConfig.ExpectedState"> <summary> The expected state of data in DynamoDB. 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. 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.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.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.FilterExpression"> <summary> The expression that is evaluated for each item. Only items that pass the expression are returned. </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.IndexName"> <summary> Name of the index to scan against. </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.KeyExpression"> <summary> The key expression that is evaluated for each item. Only items that pass the expression are returned. <para> Both KeyExpression and FilterExpression contain ExpressionAttributeNames and ExpressionAttributeValues. Attribute names or values can be added to either expression and can be referenced in either expression statement. Conflicting attribute names or values will lead to an exception being thrown. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig.FilterExpression"> <summary> The expression that is evaluated for each item. Only items that pass the expression are returned. <para> Both KeyExpression and FilterExpression contain ExpressionAttributeNames and ExpressionAttributeValues. Attribute names or values can be added to either expression and can be referenced in either expression statement. Conflicting attribute names or values will lead to an exception being thrown. </para> </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.Internal.DynamoDBRetryPolicy"> <summary> Custom DynamoDB retry policy. This policy has a slightly different exponential backoff logic compared to the default retry policy. </summary> </member> <member name="T:Amazon.Runtime.Internal.DefaultRetryPolicy"> <summary> The default implementation of the retry policy. </summary> </member> <member name="T:Amazon.Runtime.RetryPolicy"> <summary> A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries. </summary> </member> <member name="M:Amazon.Runtime.RetryPolicy.Retry(Amazon.Runtime.IExecutionContext,System.Exception)"> <summary> Checks if a retry should be performed with the given execution context and exception. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <param name="exception">The exception throw after issuing the request.</param> <returns>Returns true if the request should be retried, else false.</returns> </member> <member name="M:Amazon.Runtime.RetryPolicy.CanRetry(Amazon.Runtime.IExecutionContext)"> <summary> Returns true if the request is in a state where it can be retried, else false. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>Returns true if the request is in a state where it can be retried, else false.</returns> </member> <member name="M:Amazon.Runtime.RetryPolicy.RetryForException(Amazon.Runtime.IExecutionContext,System.Exception)"> <summary> Return true if the request should be retried for the given exception. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <param name="exception">The exception thrown by the previous request.</param> <returns>Return true if the request should be retried.</returns> </member> <member name="M:Amazon.Runtime.RetryPolicy.RetryLimitReached(Amazon.Runtime.IExecutionContext)"> <summary> Checks if the retry limit is reached. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>Return false if the request can be retried, based on number of retries.</returns> </member> <member name="M:Amazon.Runtime.RetryPolicy.WaitBeforeRetry(Amazon.Runtime.IExecutionContext)"> <summary> Waits before retrying a request. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="P:Amazon.Runtime.RetryPolicy.MaxRetries"> <summary> Maximum number of retries to be performed. This does not count the initial request. </summary> </member> <member name="P:Amazon.Runtime.RetryPolicy.Logger"> <summary> The logger used to log messages. </summary> </member> <member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.#ctor(System.Int32)"> <summary> Constructor for DefaultRetryPolicy. </summary> <param name="maxRetries">The maximum number of retries before throwing back a exception. This does not count the initial request.</param> </member> <member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.CanRetry(Amazon.Runtime.IExecutionContext)"> <summary> Returns true if the request is in a state where it can be retried, else false. </summary> <param name="executionContext">Request context containing the state of the request.</param> <returns>Returns true if the request is in a state where it can be retried, else false.</returns> </member> <member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.RetryForException(Amazon.Runtime.IExecutionContext,System.Exception)"> <summary> Return true if the request should be retried. </summary> <param name="executionContext">Request context containing the state of the request.</param> <param name="exception">The exception thrown by the previous request.</param> <returns>Return true if the request should be retried.</returns> </member> <member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.RetryLimitReached(Amazon.Runtime.IExecutionContext)"> <summary> Checks if the retry limit is reached. </summary> <param name="executionContext">Request context containing the state of the request.</param> <returns>Return false if the request can be retried, based on number of retries.</returns> </member> <member name="M:Amazon.Runtime.Internal.DefaultRetryPolicy.WaitBeforeRetry(Amazon.Runtime.IExecutionContext)"> <summary> Waits before retrying a request. The default policy implements a exponential backoff. </summary> <param name="executionContext">Request context containing the state of the request.</param> </member> <member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.MaxBackoffInMilliseconds"> <summary> The maximum value of exponential backoff in milliseconds, which will be used to wait before retrying a request. </summary> </member> <member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.ErrorCodesToRetryOn"> <summary> List of AWS specific error codes which are returned as part of the error response. These error codes will be retried. </summary> </member> <member name="P:Amazon.Runtime.Internal.DefaultRetryPolicy.WebExceptionStatusesToRetryOn"> <summary> List of WebExceptionStatus for a WebException which will be retried. </summary> </member> <member name="M:Amazon.DynamoDBv2.Internal.DynamoDBRetryPolicy.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.AmazonDynamoDBRequest"> <summary> Base class for DynamoDB operation requests. </summary> </member> <member name="T:Amazon.DynamoDBv2.AmazonDynamoDBStreamsRequest"> <summary> Base class for DynamoDBStreams operation requests. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeDefinition"> <summary> Represents an attribute for describing the key schema for the table and indexes. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeDefinition.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeDefinition.#ctor(System.String,Amazon.DynamoDBv2.ScalarAttributeType)"> <summary> Instantiates AttributeDefinition with the parameterized properties </summary> <param name="attributeName">A name for the attribute.</param> <param name="attributeType">The data type for the attribute, where: <ul> <li><code>S</code> - the attribute is of type String</li> <li><code>N</code> - the attribute is of type Number</li> <li><code>B</code> - the attribute is of type Binary</li> </ul></param> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeDefinition.AttributeName"> <summary> Gets and sets the property AttributeName. <para> A name for the attribute. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeDefinition.AttributeType"> <summary> Gets and sets the property AttributeType. <para> The data type for the attribute, where: </para> <ul> <li><code>S</code> - the attribute is of type String</li> <li><code>N</code> - the attribute is of type Number</li> <li><code>B</code> - the attribute is of type Binary</li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeValue"> <summary> Represents the data for an attribute. You can set one, and only one, of the elements. <para> Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.#ctor(System.String)"> <summary> Instantiates AttributeValue with the parameterized properties </summary> <param name="s">A String data type.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValue.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates AttributeValue with the parameterized properties </summary> <param name="ss">A String Set data type.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.B"> <summary> Gets and sets the property B. <para> A Binary data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.BOOL"> <summary> Gets and sets the property BOOL. <para> A Boolean data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.IsBOOLSet"> <summary> This property is set to true if the property <seealso cref="P:Amazon.DynamoDBv2.Model.AttributeValue.BOOL"/> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </summary> <returns> True if the related property was set or will be sent to a service; false otherwise. </returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.BS"> <summary> Gets and sets the property BS. <para> A Binary Set data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.L"> <summary> Gets and sets the property L. <para> A List of attribute values. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.IsLSet"> <summary> This property is set to true if the property <seealso cref="P:Amazon.DynamoDBv2.Model.AttributeValue.L"/> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </summary> <returns> True if the related property was set or will be sent to a service; false otherwise. </returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.M"> <summary> Gets and sets the property M. <para> A Map of attribute values. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.IsMSet"> <summary> This property is set to true if the property <seealso cref="P:Amazon.DynamoDBv2.Model.AttributeValue.M"/> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </summary> <returns> True if the related property was set or will be sent to a service; false otherwise. </returns> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.N"> <summary> Gets and sets the property N. <para> A Number data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.NS"> <summary> Gets and sets the property NS. <para> A Number Set data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.NULL"> <summary> Gets and sets the property NULL. <para> A Null data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.S"> <summary> Gets and sets the property S. <para> A String data type. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValue.SS"> <summary> Gets and sets the property SS. <para> A String Set data type. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.AttributeValueUpdate"> <summary> For the <i>UpdateItem</i> operation, represents the attributes to be modified, the action to perform on each, and the new value for each. <note> <para> You cannot use <i>UpdateItem</i> to update any primary key attributes. Instead, you will need to delete the item, and then use <i>PutItem</i> to create a new item with new attributes. </para> </note> <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> exception. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValueUpdate.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.AttributeValueUpdate.#ctor(Amazon.DynamoDBv2.Model.AttributeValue,Amazon.DynamoDBv2.AttributeAction)"> <summary> Instantiates AttributeValueUpdate with the parameterized properties </summary> <param name="value">Sets the AttributeValueUpdate Value property</param> <param name="action">Specifies how to perform the update. Valid values are <code>PUT</code> (default), <code>DELETE</code>, and <code>ADD</code>. 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> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - 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 <code>[a,b,c]</code> and the <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value would be <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - 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 <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then 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 <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. In addition, if you use <code>ADD</code> to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses <code>0</code> 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 <code>ADD</code> the number <code>3</code> to this attribute anyway, even though it currently does not exist. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute in the item, with a value of <code>3</code>. </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 <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value would be <code>[1,2,3]</code>. 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 <code>ADD</code> for any other data types. </li> </ul> <b>If no item with the specified <i>Key</i> is found:</b> <ul> <li> <code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens; there is no attribute to delete. </li> <li> <code>ADD</code> - 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></param> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValueUpdate.Action"> <summary> Gets and sets the property Action. <para> Specifies how to perform the update. Valid values are <code>PUT</code> (default), <code>DELETE</code>, and <code>ADD</code>. The behavior depends on whether the specified primary key already exists in the table. </para> <para> <b>If an item with the specified <i>Key</i> is found in the table:</b> </para> <ul> <li> <para> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </para> </li> <li> <para> <code>DELETE</code> - 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. </para> <para> 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 <code>[a,b,c]</code> and the <i>DELETE</i> action specified <code>[a,c]</code>, then the final attribute value would be <code>[b]</code>. Specifying an empty set is an error. </para> </li> <li> <para> <code>ADD</code> - 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 <code>ADD</code> depends on the data type of the attribute: </para> <ul> <li> <para> 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. </para> <note> <para> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. </para> <para> In addition, if you use <code>ADD</code> to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses <code>0</code> 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 <code>ADD</code> the number <code>3</code> to this attribute anyway, even though it currently does not exist. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute in the item, with a value of <code>3</code>. </para> </note> </li> <li> <para> 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 <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value would be <code>[1,2,3]</code>. 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. </para> <para> 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. </para> </li> </ul> <para> This action is only valid for an existing attribute whose data type is number or is a set. Do not use <code>ADD</code> for any other data types. </para> </li> </ul> <para> <b>If no item with the specified <i>Key</i> is found:</b> </para> <ul> <li> <para> <code>PUT</code> - DynamoDB creates a new item with the specified primary key, and then adds the attribute. </para> </li> <li> <para> <code>DELETE</code> - Nothing happens; there is no attribute to delete. </para> </li> <li> <para> <code>ADD</code> - 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. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.AttributeValueUpdate.Value"> <summary> Gets and sets the property Value. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemRequest"> <summary> Container for the parameters to the BatchGetItem operation. The <i>BatchGetItem</i> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. <para> A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <i>BatchGetItem</i> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <i>UnprocessedKeys</i>. You can use this value to retry the operation starting with the next item to get. </para> <important> <para> If you request more than 100 items <i>BatchGetItem</i> will return a <i>ValidationException</i> with the message "Too many items requested for the BatchGetItem call". </para> </important> <para> For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <i>UnprocessedKeys</i> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set. </para> <para> If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchGetItem</i> will return a <i>ProvisionedThroughputExceededException</i>. If <i>at least one</i> of the items is successfully processed, then <i>BatchGetItem</i> completes successfully, while returning the keys of the unread items in <i>UnprocessedKeys</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> By default, <i>BatchGetItem</i> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <i>ConsistentRead</i> to <code>true</code> for any or all tables. </para> <para> In order to minimize response latency, <i>BatchGetItem</i> retrieves items in parallel. </para> <para> When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <i>AttributesToGet</i> parameter. </para> <para> If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemRequest.#ctor(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes})"> <summary> Instantiates BatchGetItemRequest with the parameterized properties </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchGetItemRequest.#ctor(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.KeysAndAttributes},Amazon.DynamoDBv2.ReturnConsumedCapacity)"> <summary> Instantiates BatchGetItemRequest with the parameterized properties </summary> <param name="requestItems">A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. Each element in the map of items to retrieve consists of the following: <ul> <li> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </li> <li> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: <ul> <li> To access an attribute whose name conflicts with a DynamoDB reserved word. </li> <li> To create a placeholder for repeating occurrences of an attribute name in an expression. </li> <li> To prevent special characters in an attribute name from being misinterpreted in an expression. </li> </ul> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: <ul><li><code>Percentile</code></li></ul> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: <ul><li><code>{"#P":"Percentile"}</code></li></ul> You could then use this substitution in an expression, as in this example: <ul><li><code>#P = :val</code></li></ul> <note>Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime.</note> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </li> <li> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </li> <li> <i>AttributesToGet</i> - <important> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.</important> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. Note that <i>AttributesToGet</i> has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application. </li> </ul></param> <param name="returnConsumedCapacity">Sets the BatchGetItemRequest ReturnConsumedCapacity property</param> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemRequest.RequestItems"> <summary> Gets and sets the property RequestItems. <para> A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per <i>BatchGetItem</i> request. </para> <para> Each element in the map of items to retrieve consists of the following: </para> <ul> <li> <para> <i>ConsistentRead</i> - If <code>true</code>, a strongly consistent read is used; if <code>false</code> (the default), an eventually consistent read is used. </para> </li> <li> <para> <i>ExpressionAttributeNames</i> - One or more substitution tokens for attribute names in the <i>ProjectionExpression</i> parameter. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </li> <li> <para> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide <i>both</i> the partition key value and the sort key value. </para> </li> <li> <para> <i>ProjectionExpression</i> - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. </para> <para> 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. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </li> <li> <para> <i>AttributesToGet</i> - </para> <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> <para> This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. </para> </important> <para> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. </para> <para> 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> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemResponse"> <summary> Configuration for accessing Amazon BatchGetItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchGetItemResult"> <summary> Represents the output of a <i>BatchGetItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. <para> The read capacity units consumed by the operation. </para> <para> Each element consists of: </para> <ul> <li> <para> <i>TableName</i> - The table that consumed the provisioned throughput. </para> </li> <li> <para> <i>CapacityUnits</i> - The total number of capacity units consumed. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.Responses"> <summary> Gets and sets the property Responses. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchGetItemResult.UnprocessedKeys"> <summary> Gets and sets the property UnprocessedKeys. <para> 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. </para> <para> Each element consists of: </para> <ul> <li> <para> <i>Keys</i> - An array of primary key attribute values that define specific items in the table. </para> </li> <li> <para> <i>AttributesToGet</i> - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result. </para> </li> <li> <para> <i>ConsistentRead</i> - The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used. </para> </li> </ul> <para> If there are no unprocessed keys remaining, the response contains an empty <i>UnprocessedKeys</i> map. </para> </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.BatchWriteItemRequest"> <summary> Container for the parameters to the BatchWriteItem operation. The <i>BatchWriteItem</i> operation puts or deletes multiple items in one or more tables. A single call to <i>BatchWriteItem</i> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB. <note> <para> <i>BatchWriteItem</i> cannot update items. To update items, use the <i>UpdateItem</i> API. </para> </note> <para> The individual <i>PutItem</i> and <i>DeleteItem</i> operations specified in <i>BatchWriteItem</i> are atomic; however <i>BatchWriteItem</i> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <i>UnprocessedItems</i> response parameter. You can investigate and optionally resend the requests. Typically, you would call <i>BatchWriteItem</i> in a loop. Each iteration would check for unprocessed items and submit a new <i>BatchWriteItem</i> request with those unprocessed items until all items have been processed. </para> <para> Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <i>BatchWriteItem</i> will return a <i>ProvisionedThroughputExceededException</i>. </para> <important> <para> If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </important> <para> With <i>BatchWriteItem</i>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <i>BatchWriteItem</i> does not behave in the same way as individual <i>PutItem</i> and <i>DeleteItem</i> calls would. For example, you cannot specify conditions on individual put and delete requests, and <i>BatchWriteItem</i> does not return deleted items in the response. </para> <para> If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <i>BatchWriteItem</i> provides an alternative where the API performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application. </para> <para> Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit. </para> <para> If one or more of the following is true, DynamoDB rejects the entire batch write operation: </para> <ul> <li> <para> One or more tables specified in the <i>BatchWriteItem</i> request does not exist. </para> </li> <li> <para> Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. </para> </li> <li> <para> You try to perform multiple operations on the same item in the same <i>BatchWriteItem</i> request. For example, you cannot put and delete the same item in the same <i>BatchWriteItem</i> request. </para> </li> <li> <para> There are more than 25 requests in the batch. </para> </li> <li> <para> Any individual item in a batch exceeds 400 KB. </para> </li> <li> <para> The total request size exceeds 16 MB. </para> </li> </ul> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.#ctor(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.WriteRequest}})"> <summary> Instantiates BatchWriteItemRequest with the parameterized properties </summary> <param name="requestItems">A map of one or more table names and, for each table, a list of operations to be performed (<i>DeleteRequest</i> or <i>PutRequest</i>). Each element in the map consists of the following: <ul> <li> <i>DeleteRequest</i> - Perform a <i>DeleteItem</i> operation on the specified item. The item to be deleted is identified by a <i>Key</i> subelement: <ul> <li> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </li> </ul> </li> <li> <i>PutRequest</i> - Perform a <i>PutItem</i> operation on the specified item. The item to be put is identified by an <i>Item</i> subelement: <ul> <li> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </li> </ul> </li> </ul></param> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.RequestItems"> <summary> Gets and sets the property RequestItems. <para> 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: </para> <ul> <li> <para> <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: </para> <ul> <li> <para> <i>Key</i> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key. </para> </li> </ul> </li> <li> <para> <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: </para> <ul> <li> <para> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> 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. </para> </li> </ul> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemRequest.ReturnItemCollectionMetrics"> <summary> Gets and sets the property ReturnItemCollectionMetrics. <para> Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchWriteItemResponse"> <summary> Configuration for accessing Amazon BatchWriteItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.BatchWriteItemResult"> <summary> Represents the output of a <i>BatchWriteItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. <para> The capacity units consumed by the operation. </para> <para> Each element consists of: </para> <ul> <li> <para> <i>TableName</i> - The table that consumed the provisioned throughput. </para> </li> <li> <para> <i>CapacityUnits</i> - The total number of capacity units consumed. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.ItemCollectionMetrics"> <summary> Gets and sets the property ItemCollectionMetrics. <para> 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. </para> <para> Each entry consists of the following subelements: </para> <ul> <li> <para> <i>ItemCollectionKey</i> - The partition key value of the item collection. This is the same as the partition key value of the item. </para> </li> <li> <para> <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. </para> <para> The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.BatchWriteItemResult.UnprocessedItems"> <summary> Gets and sets the property UnprocessedItems. <para> 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. </para> <para> 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>). </para> <ul> <li> <para> <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: </para> <ul> <li> <para> <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. </para> </li> </ul> </li> <li> <para> <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: </para> <ul> <li> <para> <i>Item</i> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> 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. </para> </li> </ul> </li> </ul> <para> If there are no unprocessed items remaining, the response contains an empty <i>UnprocessedItems</i> map. </para> </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.Capacity"> <summary> Represents the amount of provisioned throughput capacity consumed on a table or an index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Capacity.CapacityUnits"> <summary> Gets and sets the property CapacityUnits. <para> The total number of capacity units consumed on a table or an index. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Condition"> <summary> Represents the selection criteria for a <i>Query</i> or <i>Scan</i> operation: <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>, only the following comparison operators are supported: </para> <para> <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code> </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 evaluates the scan results and returns only the desired values. </para> </li> </ul> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.Condition.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Condition.AttributeValueList"> <summary> Gets and sets the property AttributeValueList. <para> 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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Condition.ComparisonOperator"> <summary> Gets and sets the property ComparisonOperator. <para> A comparator for evaluating attributes. For example, equals, greater than, less than, etc. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> The following are descriptions of each comparison operator. </para> <ul> <li> <para> <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NE</code> : Not equal. <code>NE</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <i>false</i>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>CONTAINS</code> : Checks for a subsequence, or value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set. </para> <para> CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set. </para> <para> NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>IN</code> : Checks for matching elements within two sets. </para> <para> <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> <para> For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ConditionalCheckFailedException"> <summary> DynamoDB 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> 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 the request asked for it. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer Guide</i>. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.CapacityUnits"> <summary> Gets and sets the property CapacityUnits. <para> The total number of capacity units consumed by the operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.GlobalSecondaryIndexes"> <summary> Gets and sets the property GlobalSecondaryIndexes. <para> The amount of throughput consumed on each global index affected by the operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.LocalSecondaryIndexes"> <summary> Gets and sets the property LocalSecondaryIndexes. <para> The amount of throughput consumed on each local index affected by the operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.Table"> <summary> Gets and sets the property Table. <para> The amount of throughput consumed on the table affected by the operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ConsumedCapacity.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table that was affected by the operation. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateGlobalSecondaryIndexAction"> <summary> Represents a new global secondary index to be added to an existing table. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateGlobalSecondaryIndexAction.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the global secondary index to be created. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateGlobalSecondaryIndexAction.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The key schema for the global secondary index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateGlobalSecondaryIndexAction.Projection"> <summary> Gets and sets the property Projection. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateGlobalSecondaryIndexAction.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableRequest"> <summary> Container for the parameters to the CreateTable operation. The <i>CreateTable</i> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions. <para> <i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, DynamoDB immediately returns a response with a <i>TableStatus</i> of <code>CREATING</code>. After the table is created, DynamoDB sets the <i>TableStatus</i> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </para> <para> You can optionally define secondary indexes on the new table, as part of the <i>CreateTable</i> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time. </para> <para> You can use the <i>DescribeTable</i> API to check the table status. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement})"> <summary> Instantiates CreateTableRequest with the parameterized properties </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.CreateTableRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.DynamoDBv2.Model.KeySchemaElement},System.Collections.Generic.List{Amazon.DynamoDBv2.Model.AttributeDefinition},Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Instantiates CreateTableRequest with the parameterized properties </summary> <param name="tableName">The name of the table to create.</param> <param name="keySchema">Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each <i>KeySchemaElement</i> in the array is composed of: <ul> <li> <i>AttributeName</i> - The name of this key attribute. </li> <li> <i>KeyType</i> - The role that the key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="attributeDefinitions">An array of attributes that describe the key schema for the table and indexes.</param> <param name="provisionedThroughput">Sets the CreateTableRequest ProvisionedThroughput property</param> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.AttributeDefinitions"> <summary> Gets and sets the property AttributeDefinitions. <para> An array of attributes that describe the key schema for the table and indexes. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.GlobalSecondaryIndexes"> <summary> Gets and sets the property GlobalSecondaryIndexes. <para> 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: </para> <ul> <li> <para> <i>IndexName</i> - The name of the global secondary index. Must be unique only for this table. </para> </li> <li> <para> <i>KeySchema</i> - Specifies the key schema for the global secondary index. </para> </li> <li> <para> <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: </para> <ul> <li> <para> <i>ProjectionType</i> - One of the following: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index. </para> </li> <li> <para> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </para> </li> <li> <para> <code>ALL</code> - All of the table attributes are projected into the index. </para> </li> </ul> </li> <li> <para> <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 provided 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. </para> </li> </ul> </li> <li> <para> <i>ProvisionedThroughput</i> - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.KeySchema"> <summary> Gets and sets the property KeySchema. <para> Specifies the attributes that make up the primary key for a table or an index. The attributes in <i>KeySchema</i> must also be defined in the <i>AttributeDefinitions</i> array. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data Model</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Each <i>KeySchemaElement</i> in the array is composed of: </para> <ul> <li> <para> <i>AttributeName</i> - The name of this key attribute. </para> </li> <li> <para> <i>KeyType</i> - The role that the key attribute will assume: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> <para> For a simple primary key (partition key), you must provide exactly one element with a <i>KeyType</i> of <code>HASH</code>. </para> <para> For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a <i>KeyType</i> of <code>HASH</code>, and the second element must have a <i>KeyType</i> of <code>RANGE</code>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key">Specifying the Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.LocalSecondaryIndexes"> <summary> Gets and sets the property LocalSecondaryIndexes. <para> One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. </para> <para> Each local secondary index in the array includes the following: </para> <ul> <li> <para> <i>IndexName</i> - The name of the local secondary index. Must be unique only for this table. </para> </li> <li> <para> <i>KeySchema</i> - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table. </para> </li> <li> <para> <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: </para> <ul> <li> <para> <i>ProjectionType</i> - One of the following: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index. </para> </li> <li> <para> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </para> </li> <li> <para> <code>ALL</code> - All of the table attributes are projected into the index. </para> </li> </ul> </li> <li> <para> <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 provided 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. </para> </li> </ul> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.StreamSpecification"> <summary> Gets and sets the property StreamSpecification. <para> The settings for DynamoDB Streams on the table. These settings consist of: </para> <ul> <li> <para> <i>StreamEnabled</i> - Indicates whether Streams is to be enabled (true) or disabled (false). </para> </li> <li> <para> <i>StreamViewType</i> - When an item in the table is modified, <i>StreamViewType</i> determines what information is written to the table's stream. Valid values for <i>StreamViewType</i> are: </para> <ul> <li> <para> <i>KEYS_ONLY</i> - Only the key attributes of the modified item are written to the stream. </para> </li> <li> <para> <i>NEW_IMAGE</i> - The entire item, as it appears after it was modified, is written to the stream. </para> </li> <li> <para> <i>OLD_IMAGE</i> - The entire item, as it appeared before it was modified, is written to the stream. </para> </li> <li> <para> <i>NEW_AND_OLD_IMAGES</i> - Both the new and the old item images of the item are written to the stream. </para> </li> </ul> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table to create. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableResponse"> <summary> Configuration for accessing Amazon CreateTable service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.CreateTableResult"> <summary> Represents the output of a <i>CreateTable</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.CreateTableResult.TableDescription"> <summary> Gets and sets the property TableDescription. </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.DeleteGlobalSecondaryIndexAction"> <summary> Represents a global secondary index to be deleted from an existing table. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteGlobalSecondaryIndexAction.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the global secondary index to be deleted. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemRequest"> <summary> Container for the parameters to the DeleteItem operation. Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value. <para> In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> Unless you specify conditions, the <i>DeleteItem</i> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response. </para> <para> Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Instantiates DeleteItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Instantiates DeleteItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table from which to delete the item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were deleted. For <i>DeleteItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - The content of the old item is returned. </li> </ul></param> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ConditionalOperator"> <summary> Gets and sets the property ConditionalOperator. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A logical operator to apply to the conditions in the <i>Expected</i> map: </para> <ul> <li> <para> <code>AND</code> - If all of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> <li> <para> <code>OR</code> - If at least one of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> </ul> <para> If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default. </para> <para> The operation will succeed only if the entire map evaluates to true. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ConditionExpression"> <summary> Gets and sets the property ConditionExpression. <para> A condition that must be satisfied in order for a conditional <i>DeleteItem</i> to succeed. </para> <para> An expression can contain any of the following: </para> <ul> <li> <para> Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </para> <para> These function names are case-sensitive. </para> </li> <li> <para> Comparison operators: <code> = | <![CDATA[<]]><![CDATA[>]]> | <![CDATA[<]]> | <![CDATA[>]]> | <![CDATA[<]]>= | <![CDATA[>]]>= | BETWEEN | IN</code> </para> </li> <li> <para> Logical operators: <code>AND | OR | NOT</code> </para> </li> </ul> <para> For more information on condition expressions, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ConditionExpression</i> replaces the legacy <i>ConditionalOperator</i> and <i>Expected</i> parameters. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.Expected"> <summary> Gets and sets the property Expected. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A map of attribute/condition pairs. <i>Expected</i> provides a conditional block for the <i>DeleteItem</i> operation. </para> <para> Each element of <i>Expected</i> consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each <i>Expected</i> element, the result of the evaluation is either true or false. </para> <para> If you specify more than one element 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.) </para> <para> If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails. </para> <para> <i>Expected</i> contains the following: </para> <ul> <li> <para> <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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> The following are descriptions of each comparison operator. </para> <ul> <li> <para> <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NE</code> : Not equal. <code>NE</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <i>false</i>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>CONTAINS</code> : Checks for a subsequence, or value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set. </para> <para> CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set. </para> <para> NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>IN</code> : Checks for matching elements within two sets. </para> <para> <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> </li> </ul> <para> For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>: </para> <ul> <li> <para> <i>Value</i> - A value for DynamoDB to compare with an attribute. </para> </li> <li> <para> <i>Exists</i> - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: </para> <ul> <li> <para> If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. </para> </li> <li> <para> If <i>Exists</i> is <code>false</code>, 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. </para> </li> </ul> <para> Note that the default value for <i>Exists</i> is <code>true</code>. </para> </li> </ul> <para> The <i>Value</i> and <i>Exists</i> parameters are incompatible with <i>AttributeValueList</i> and <i>ComparisonOperator</i>. Note that if you use both sets of parameters at once, DynamoDB will return a <i>ValidationException</i> exception. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. <para> One or more values that can be substituted in an expression. </para> <para> Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <i>ProductStatus</i> attribute was one of the following: </para> <para> <code>Available | Backordered | Discontinued</code> </para> <para> You would first need to specify <i>ExpressionAttributeValues</i> as follows: </para> <para> <code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code> </para> <para> You could then use these values in an expression, such as this: </para> <para> <code>ProductStatus IN (:avail, :back, :disc)</code> </para> <para> For more information on expression attribute values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.Key"> <summary> Gets and sets the property Key. <para> A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to delete. </para> <para> For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnItemCollectionMetrics"> <summary> Gets and sets the property ReturnItemCollectionMetrics. <para> Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.ReturnValues"> <summary> Gets and sets the property ReturnValues. <para> 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: </para> <ul> <li> <para> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </para> </li> <li> <para> <code>ALL_OLD</code> - The content of the old item is returned. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table from which to delete the item. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemResponse"> <summary> Configuration for accessing Amazon DeleteItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteItemResult"> <summary> Represents the output of a <i>DeleteItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.Attributes"> <summary> Gets and sets the property Attributes. <para> 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 <code>ALL_OLD</code> in the request. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteItemResult.ItemCollectionMetrics"> <summary> Gets and sets the property ItemCollectionMetrics. <para> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. </para> <para> Each <i>ItemCollectionMetrics</i> element consists of: </para> <ul> <li> <para> <i>ItemCollectionKey</i> - The partition key value of the item collection. This is the same as the partition key value of the item itself. </para> </li> <li> <para> <i>SizeEstimateRange</i> - An estimate of item collection size, in gigabytes. This value 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. </para> <para> The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </para> </li> </ul> </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.DeleteRequest"> <summary> Represents a request to perform a <i>DeleteItem</i> operation on an item. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteRequest.#ctor(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Instantiates DeleteRequest with the parameterized properties </summary> <param name="key">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.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteRequest.Key"> <summary> Gets and sets the property Key. <para> 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. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableRequest"> <summary> Container for the parameters to the DeleteTable operation. The <i>DeleteTable</i> operation deletes a table and all of its items. After a <i>DeleteTable</i> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <i>ResourceInUseException</i>. If the specified table does not exist, DynamoDB returns a <i>ResourceNotFoundException</i>. If table is already in the <code>DELETING</code> state, no error is returned. <note> <para> DynamoDB might continue to accept data read and write operations, such as <i>GetItem</i> and <i>PutItem</i>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para> </note> <para> When you delete a table, any indexes on that table are also deleted. </para> <para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para> <para> Use the <i>DescribeTable</i> API to check the status of the table. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteTableRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DeleteTableRequest.#ctor(System.String)"> <summary> Instantiates DeleteTableRequest with the parameterized properties </summary> <param name="tableName"> The name of the table to delete.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteTableRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table to delete. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableResponse"> <summary> Configuration for accessing Amazon DeleteTable service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DeleteTableResult"> <summary> Represents the output of a <i>DeleteTable</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DeleteTableResult.TableDescription"> <summary> Gets and sets the property TableDescription. </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.DescribeLimitsRequest"> <summary> Container for the parameters to the DescribeLimits operation. Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <i>DescribeLimits</i> API lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para> <para> For example, you could use one of the AWS SDKs to do the following: </para> <ol> <li>Call <i>DescribeLimits</i> for a particular region to obtain your current account limits on provisioned capacity there.</li> <li>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</li> <li>Call <i>ListTables</i> to obtain a list of all your DynamoDB tables.</li> <li> <para> For each table name listed by <i>ListTables</i>, do the following: </para> <ul> <li>Call <i>DescribeTable</i> with the table name.</li> <li>Use the data returned by <i>DescribeTable</i> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</li> <li>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</li> </ul> </li> <li>Report the account limits for that region returned by <i>DescribeLimits</i>, along with the total current provisioned capacity levels you have calculated.</li> </ol> <para> This will let you see whether you are getting close to your account-level limits. </para> <para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para> <para> For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para> <note> <para> <i>DescribeLimits</i> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para> </note> <para> The <i>DescribeLimits</i> Request element has no content. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeLimitsResponse"> <summary> Configuration for accessing Amazon DescribeLimits service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeLimitsResult"> <summary> Represents the output of a <i>DescribeLimits</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeLimitsResult.AccountMaxReadCapacityUnits"> <summary> Gets and sets the property AccountMaxReadCapacityUnits. <para> The maximum total read capacity units that your account allows you to provision across all of your tables in this region. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeLimitsResult.AccountMaxWriteCapacityUnits"> <summary> Gets and sets the property AccountMaxWriteCapacityUnits. <para> The maximum total write capacity units that your account allows you to provision across all of your tables in this region. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeLimitsResult.TableMaxReadCapacityUnits"> <summary> Gets and sets the property TableMaxReadCapacityUnits. <para> The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs). </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeLimitsResult.TableMaxWriteCapacityUnits"> <summary> Gets and sets the property TableMaxWriteCapacityUnits. <para> The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs). </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeLimitsResponse.DescribeLimitsResult"> <summary> Gets and sets the DescribeLimitsResult property. Represents the output of a DescribeLimits operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeStreamRequest"> <summary> Container for the parameters to the DescribeStream operation. Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note> <para> You can call <i>DescribeStream</i> at a maximum rate of 10 times per second. </para> </note> <para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more data. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeStreamRequest.ExclusiveStartShardId"> <summary> Gets and sets the property ExclusiveStartShardId. <para> The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeStreamRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of shard objects to return. The upper limit is 100. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeStreamRequest.StreamArn"> <summary> Gets and sets the property StreamArn. <para> The Amazon Resource Name (ARN) for the stream. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeStreamResponse"> <summary> Configuration for accessing Amazon DescribeStream service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeStreamResult"> <summary> Represents the output of a <i>DescribeStream</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeStreamResult.StreamDescription"> <summary> Gets and sets the property StreamDescription. <para> A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeStreamResponse.DescribeStreamResult"> <summary> Gets and sets the DescribeStreamResult property. Represents the output of a DescribeStream operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableRequest"> <summary> Container for the parameters to the DescribeTable operation. Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. <note> <para> If you issue a <i>DescribeTable</i> request immediately after a <i>CreateTable</i> request, DynamoDB might return a <i>ResourceNotFoundException</i>. This is because <i>DescribeTable</i> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <i>DescribeTable</i> request again. </para> </note> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DescribeTableRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.DescribeTableRequest.#ctor(System.String)"> <summary> Instantiates DescribeTableRequest with the parameterized properties </summary> <param name="tableName"> The name of the table to describe.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeTableRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table to describe. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableResponse"> <summary> Configuration for accessing Amazon DescribeTable service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.DescribeTableResult"> <summary> Represents the output of a <i>DescribeTable</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.DescribeTableResult.Table"> <summary> Gets and sets the property Table. </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.ExpectedAttributeValue"> <summary> Represents a condition to be compared with an attribute value. This condition can be used with <i>DeleteItem</i>, <i>PutItem</i> or <i>UpdateItem</i> operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use <i>ExpectedAttributeValue</i> in one of two different ways: <ul> <li> <para> Use <i>AttributeValueList</i> to specify one or more values to compare against an attribute. Use <i>ComparisonOperator</i> to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. </para> </li> <li> <para> Use <i>Value</i> to specify a value that DynamoDB will compare against an attribute. If the values match, then <i>ExpectedAttributeValue</i> evaluates to true and the conditional operation succeeds. Optionally, you can also set <i>Exists</i> to false, indicating that you <i>do not</i> expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false. </para> </li> </ul> <para> <i>Value</i> and <i>Exists</i> are incompatible with <i>AttributeValueList</i> and <i>ComparisonOperator</i>. Note that if you use both sets of parameters at once, DynamoDB will return a <i>ValidationException</i> exception. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.#ctor(Amazon.DynamoDBv2.Model.AttributeValue)"> <summary> Instantiates ExpectedAttributeValue with the parameterized properties </summary> <param name="value">Sets the ExpectedAttributeValue Value property</param> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.#ctor(System.Boolean)"> <summary> Instantiates ExpectedAttributeValue with the parameterized properties </summary> <param name="exists">Causes DynamoDB to evaluate the value before attempting a conditional operation: <ul> <li> If <i>Exists</i> is <code>true</code>, 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 <code>false</code>, DynamoDB assumes that the attribute value does not 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 <code>true</code>. 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 <code>true</code>, because it is implied. DynamoDB returns a <i>ValidationException</i> if: <ul> <li> <i>Exists</i> is <code>true</code> 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 <code>false</code> but you also provide a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </li> </ul></param> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.AttributeValueList"> <summary> Gets and sets the property AttributeValueList. <para> 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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> <para> For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.ComparisonOperator"> <summary> Gets and sets the property ComparisonOperator. <para> A comparator for evaluating attributes in the <i>AttributeValueList</i>. For example, equals, greater than, less than, etc. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> The following are descriptions of each comparison operator. </para> <ul> <li> <para> <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NE</code> : Not equal. <code>NE</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <i>false</i>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>CONTAINS</code> : Checks for a subsequence, or value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set. </para> <para> CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set. </para> <para> NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>IN</code> : Checks for matching elements within two sets. </para> <para> <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.Exists"> <summary> Gets and sets the property Exists. <para> Causes DynamoDB to evaluate the value before attempting a conditional operation: </para> <ul> <li> <para> If <i>Exists</i> is <code>true</code>, 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>. </para> </li> <li> <para> If <i>Exists</i> is <code>false</code>, DynamoDB assumes that the attribute value does not 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>. </para> </li> </ul> <para> The default setting for <i>Exists</i> is <code>true</code>. 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 <code>true</code>, because it is implied. </para> <para> DynamoDB returns a <i>ValidationException</i> if: </para> <ul> <li> <para> <i>Exists</i> is <code>true</code> but there is no <i>Value</i> to check. (You expect a value to exist, but don't specify what that value is.) </para> </li> <li> <para> <i>Exists</i> is <code>false</code> but you also provide a <i>Value</i>. (You cannot expect an attribute to have a value, while also expecting it not to exist.) </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ExpectedAttributeValue.Value"> <summary> Gets and sets the property Value. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ExpiredIteratorException"> <summary> DynamoDBStreams exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ExpiredIteratorException.#ctor(System.String)"> <summary> Constructs a new ExpiredIteratorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemRequest"> <summary> Container for the parameters to the GetItem operation. The <i>GetItem</i> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <i>GetItem</i> does not return any data. <para> <i>GetItem</i> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <i>ConsistentRead</i> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Instantiates GetItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.GetItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Boolean)"> <summary> Instantiates GetItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the requested item.</param> <param name="key">A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="consistentRead">Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.AttributesToGet"> <summary> Gets and sets the property AttributesToGet. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> <para> This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. </para> </important> <para> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. </para> <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ConsistentRead"> <summary> Gets and sets the property ConsistentRead. <para> Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.Key"> <summary> Gets and sets the property Key. <para> A map of attribute names to <i>AttributeValue</i> objects, representing the primary key of the item to retrieve. </para> <para> For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ProjectionExpression"> <summary> Gets and sets the property ProjectionExpression. <para> A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. </para> <para> 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. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ProjectionExpression</i> replaces the legacy <i>AttributesToGet</i> parameter. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table containing the requested item. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemResponse"> <summary> Configuration for accessing Amazon GetItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetItemResult"> <summary> Represents the output of a <i>GetItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResult.Item"> <summary> Gets and sets the property Item. <para> A map of attribute names to <i>AttributeValue</i> objects, as specified by <i>AttributesToGet</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetItemResult.IsItemSet"> <summary> This property is set to true if the property <seealso cref="P:Amazon.DynamoDBv2.Model.GetItemResult.Item"/> is set; false otherwise. This property can be used to determine if the related property was returned by a service response or if the related property should be sent to the service during a service call. </summary> <returns> True if the related property was set or will be sent to a service; false otherwise. </returns> </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.GetRecordsRequest"> <summary> Container for the parameters to the GetRecords operation. Retrieves the stream records from a given shard. <para> Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records. </para> <note> <para> GetRecords can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes first. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetRecordsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of records to return from the shard. The upper limit is 1000. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetRecordsRequest.ShardIterator"> <summary> Gets and sets the property ShardIterator. <para> A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetRecordsResponse"> <summary> Configuration for accessing Amazon GetRecords service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetRecordsResult"> <summary> Represents the output of a <i>GetRecords</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetRecordsResult.NextShardIterator"> <summary> Gets and sets the property NextShardIterator. <para> The next position in the shard from which to start sequentially reading stream records. If set to <code>null</code>, the shard has been closed and the requested iterator will not return any more data. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetRecordsResult.Records"> <summary> Gets and sets the property Records. <para> The stream records from the shard, which were retrieved using the shard iterator. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetRecordsResponse.GetRecordsResult"> <summary> Gets and sets the GetRecordsResult property. Represents the output of a GetRecords operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetShardIteratorRequest"> <summary> Container for the parameters to the GetShardIterator operation. Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent <code>GetRecords</code> request to read the stream records from the shard. <note> <para> A shard iterator expires 15 minutes after it is returned to the requester. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorRequest.SequenceNumber"> <summary> Gets and sets the property SequenceNumber. <para> The sequence number of a stream record in the shard from which to start reading. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorRequest.ShardId"> <summary> Gets and sets the property ShardId. <para> The identifier of the shard. The iterator will be returned for this shard ID. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorRequest.ShardIteratorType"> <summary> Gets and sets the property ShardIteratorType. <para> Determines how the shard iterator is used to start reading stream records from the shard: </para> <ul> <li> <para> <code>AT_SEQUENCE_NUMBER</code> - Start reading exactly from the position denoted by a specific sequence number. </para> </li> <li> <para> <code>AFTER_SEQUENCE_NUMBER</code> - Start reading right after the position denoted by a specific sequence number. </para> </li> <li> <para> <code>TRIM_HORIZON</code> - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. </para> </li> <li> <para> <code>LATEST</code> - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorRequest.StreamArn"> <summary> Gets and sets the property StreamArn. <para> The Amazon Resource Name (ARN) for the stream. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetShardIteratorResponse"> <summary> Configuration for accessing Amazon GetShardIterator service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GetShardIteratorResult"> <summary> Represents the output of a <i>GetShardIterator</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorResult.ShardIterator"> <summary> Gets and sets the property ShardIterator. <para> The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GetShardIteratorResponse.GetShardIteratorResult"> <summary> Gets and sets the GetShardIteratorResult property. Represents the output of a GetShardIterator operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex"> <summary> Represents the properties of a global secondary index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the global secondary index. The name must be unique among all other indexes on this table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.Projection"> <summary> Gets and sets the property Projection. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndex.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription"> <summary> Represents the properties of a global secondary index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.Backfilling"> <summary> Gets and sets the property Backfilling. <para> Indicates whether the index is currently backfilling. <i>Backfilling</i> is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and <i>Backfilling</i> is false. </para> <note> <para> For indexes that were created during a <i>CreateTable</i> operation, the <i>Backfilling</i> attribute does not appear in the <i>DescribeTable</i> output. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexArn"> <summary> Gets and sets the property IndexArn. <para> The Amazon Resource Name (ARN) that uniquely identifies the index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the global secondary index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexSizeBytes"> <summary> Gets and sets the property IndexSizeBytes. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.IndexStatus"> <summary> Gets and sets the property IndexStatus. <para> The current state of the global secondary index: </para> <ul> <li> <para> <i>CREATING</i> - The index is being created. </para> </li> <li> <para> <i>UPDATING</i> - The index is being updated. </para> </li> <li> <para> <i>DELETING</i> - The index is being deleted. </para> </li> <li> <para> <i>ACTIVE</i> - The index is ready for use. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.ItemCount"> <summary> Gets and sets the property ItemCount. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.Projection"> <summary> Gets and sets the property Projection. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexDescription.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate"> <summary> Represents one of the following: <ul> <li> <para> A new global secondary index to be added to an existing table. </para> </li> <li> <para> New provisioned throughput parameters for an existing global secondary index. </para> </li> <li> <para> An existing global secondary index to be removed from an existing table. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate.Create"> <summary> Gets and sets the property Create. <para> The parameters required for creating a global secondary index on an existing table: </para> <ul> <li> <para> <code>IndexName </code> </para> </li> <li> <para> <code>KeySchema </code> </para> </li> <li> <para> <code>AttributeDefinitions </code> </para> </li> <li> <para> <code>Projection </code> </para> </li> <li> <para> <code>ProvisionedThroughput </code> </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate.Delete"> <summary> Gets and sets the property Delete. <para> The name of an existing global secondary index to be removed. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.GlobalSecondaryIndexUpdate.Update"> <summary> Gets and sets the property Update. <para> The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.InternalServerErrorException"> <summary> DynamoDB 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.ItemCollectionMetrics"> <summary> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.ItemCollectionKey"> <summary> Gets and sets the property ItemCollectionKey. <para> The partition key value of the item collection. This value is the same as the partition key value of the item. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ItemCollectionMetrics.SizeEstimateRangeGB"> <summary> Gets and sets the property SizeEstimateRangeGB. <para> An estimate of item collection size, in gigabytes. This value 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. </para> <para> The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ItemCollectionSizeLimitExceededException"> <summary> DynamoDB 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> Represents a set of primary keys and, for each key, the attributes to retrieve from the table. <para> For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide <i>both</i> the partition key and the sort key. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.AttributesToGet"> <summary> Gets and sets the property AttributesToGet. <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.ConsistentRead"> <summary> Gets and sets the property ConsistentRead. <para> The consistency of a read operation. If set to <code>true</code>, then a strongly consistent read is used; otherwise, an eventually consistent read is used. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.Keys"> <summary> Gets and sets the property Keys. <para> The primary key attribute values that define the items and the attributes associated with the items. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeysAndAttributes.ProjectionExpression"> <summary> Gets and sets the property ProjectionExpression. <para> A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the <i>ProjectionExpression</i> must be separated by commas. </para> <para> 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. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ProjectionExpression</i> replaces the legacy <i>AttributesToGet</i> parameter. </para> </note> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.KeySchemaElement"> <summary> Represents <i>a single element</i> 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> A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one <i>KeySchemaElement</i> (for the partition key). A composite primary key would require one <i>KeySchemaElement</i> for the partition key, and another <i>KeySchemaElement</i> for the sort key. </para> <para> A <i>KeySchemaElement</i> must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.KeySchemaElement.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.KeySchemaElement.#ctor(System.String,Amazon.DynamoDBv2.KeyType)"> <summary> Instantiates KeySchemaElement with the parameterized properties </summary> <param name="attributeName">The name of a key attribute.</param> <param name="keyType">The role that this key attribute will assume: <ul> <li><code>HASH</code> - partition key </li> <li><code>RANGE</code> - sort key</li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</note></param> </member> <member name="P:Amazon.DynamoDBv2.Model.KeySchemaElement.AttributeName"> <summary> Gets and sets the property AttributeName. <para> The name of a key attribute. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.KeySchemaElement.KeyType"> <summary> Gets and sets the property KeyType. <para> The role that this key attribute will assume: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.LimitExceededException"> <summary> DynamoDB 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.ListStreamsRequest"> <summary> Container for the parameters to the ListStreams operation. Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table. <note> <para> You can call <i>ListStreams</i> at a maximum rate of 5 times per second. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsRequest.ExclusiveStartStreamArn"> <summary> Gets and sets the property ExclusiveStartStreamArn. <para> The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsRequest.Limit"> <summary> Gets and sets the property Limit. <para> The maximum number of streams to return. The upper limit is 100. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsRequest.TableName"> <summary> Gets and sets the property TableName. <para> If this parameter is provided, then only the streams associated with this table name are returned. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListStreamsResponse"> <summary> Configuration for accessing Amazon ListStreams service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListStreamsResult"> <summary> Represents the output of a <i>ListStreams</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsResult.LastEvaluatedStreamArn"> <summary> Gets and sets the property LastEvaluatedStreamArn. <para> The stream ARN 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. </para> <para> If <code>LastEvaluatedStreamArn</code> is empty, then the "last page" of results has been processed and there is no more data to be retrieved. </para> <para> If <code>LastEvaluatedStreamArn</code> is not empty, it 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 <code>LastEvaluatedStreamArn</code> is empty. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsResult.Streams"> <summary> Gets and sets the property Streams. <para> A list of stream descriptors associated with the current account and endpoint. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListStreamsResponse.ListStreamsResult"> <summary> Gets and sets the ListStreamsResult property. Represents the output of a ListStreams operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesRequest"> <summary> Container for the parameters to the ListTables operation. Returns an array of table names associated with the current account and endpoint. The output from <i>ListTables</i> is paginated, with each page returning a maximum of 100 table names. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesRequest.#ctor(System.String)"> <summary> Instantiates ListTablesRequest with the parameterized properties </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.ListTablesRequest.#ctor(System.String,System.Int32)"> <summary> Instantiates ListTablesRequest with the parameterized properties </summary> <param name="exclusiveStartTableName">The first table name that this operation will evaluate. Use the value that was returned for <i>LastEvaluatedTableName</i> in a previous operation, so that you can obtain the next page of results.</param> <param name="limit"> A maximum number of table names to return. If this parameter is not specified, the limit is 100.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesRequest.ExclusiveStartTableName"> <summary> Gets and sets the property ExclusiveStartTableName. <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesRequest.Limit"> <summary> Gets and sets the property Limit. <para> A maximum number of table names to return. If this parameter is not specified, the limit is 100. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesResponse"> <summary> Configuration for accessing Amazon ListTables service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ListTablesResult"> <summary> Represents the output of a <i>ListTables</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesResult.LastEvaluatedTableName"> <summary> Gets and sets the property LastEvaluatedTableName. <para> 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. </para> <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ListTablesResult.TableNames"> <summary> Gets and sets the property TableNames. <para> The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. </para> <para> 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. </para> </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.LocalSecondaryIndex"> <summary> Represents the properties of a local secondary index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the local secondary index. The name must be unique among all other indexes on this table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndex.Projection"> <summary> Gets and sets the property Projection. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription"> <summary> Represents the properties of a local secondary index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.IndexArn"> <summary> Gets and sets the property IndexArn. <para> The Amazon Resource Name (ARN) that uniquely identifies the index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.IndexName"> <summary> Gets and sets the property IndexName. <para> Represents the name of the local secondary index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.IndexSizeBytes"> <summary> Gets and sets the property IndexSizeBytes. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.ItemCount"> <summary> Gets and sets the property ItemCount. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: </para> <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.LocalSecondaryIndexDescription.Projection"> <summary> Gets and sets the property Projection. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.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.Projection.NonKeyAttributes"> <summary> Gets and sets the property NonKeyAttributes. <para> Represents the non-key attribute names which will be projected into the index. </para> <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Projection.ProjectionType"> <summary> Gets and sets the property ProjectionType. <para> The set of attributes that are projected into the index: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index. </para> </li> <li> <para> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </para> </li> <li> <para> <code>ALL</code> - All of the table attributes are projected into the index. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughput"> <summary> Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the <i>UpdateTable</i> operation. <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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughput.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ProvisionedThroughput.#ctor(System.Int64,System.Int64)"> <summary> Instantiates ProvisionedThroughput with the parameterized properties </summary> <param name="readCapacityUnits">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 <i>Amazon DynamoDB Developer Guide</i>.</param> <param name="writeCapacityUnits">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 <i>Amazon DynamoDB Developer Guide</i>.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughput.ReadCapacityUnits"> <summary> Gets and sets the property ReadCapacityUnits. <para> 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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughput.WriteCapacityUnits"> <summary> Gets and sets the property WriteCapacityUnits. <para> 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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription"> <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.ProvisionedThroughputDescription.LastDecreaseDateTime"> <summary> Gets and sets the property LastDecreaseDateTime. <para> The date and time of the last provisioned throughput decrease for this table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.LastIncreaseDateTime"> <summary> Gets and sets the property LastIncreaseDateTime. <para> The date and time of the last provisioned throughput increase for this table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.NumberOfDecreasesToday"> <summary> Gets and sets the property NumberOfDecreasesToday. <para> 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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.ReadCapacityUnits"> <summary> Gets and sets the property ReadCapacityUnits. <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ProvisionedThroughputDescription.WriteCapacityUnits"> <summary> Gets and sets the property WriteCapacityUnits. <para> The maximum number of writes consumed per second before DynamoDB returns a <i>ThrottlingException</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ProvisionedThroughputExceededException"> <summary> DynamoDB 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. Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. <para> In addition to putting an item, you can also return the item's attribute values in the same operation, using the <i>ReturnValues</i> parameter. </para> <para> When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> You can request that <i>PutItem</i> return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the <i>ReturnValues</i> description below. </para> <note> <para> To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists. </para> </note> <para> For more information about using this API, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Instantiates PutItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.PutItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},Amazon.DynamoDBv2.ReturnValue)"> <summary> Instantiates PutItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table to contain the item.</param> <param name="item">A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. Each element in the <i>Item</i> map is an <i>AttributeValue</i> object.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared before they were updated with the <i>PutItem</i> request. For <i>PutItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> </ul></param> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ConditionalOperator"> <summary> Gets and sets the property ConditionalOperator. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A logical operator to apply to the conditions in the <i>Expected</i> map: </para> <ul> <li> <para> <code>AND</code> - If all of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> <li> <para> <code>OR</code> - If at least one of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> </ul> <para> If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default. </para> <para> The operation will succeed only if the entire map evaluates to true. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ConditionExpression"> <summary> Gets and sets the property ConditionExpression. <para> A condition that must be satisfied in order for a conditional <i>PutItem</i> operation to succeed. </para> <para> An expression can contain any of the following: </para> <ul> <li> <para> Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </para> <para> These function names are case-sensitive. </para> </li> <li> <para> Comparison operators: <code> = | <![CDATA[<]]><![CDATA[>]]> | <![CDATA[<]]> | <![CDATA[>]]> | <![CDATA[<]]>= | <![CDATA[>]]>= | BETWEEN | IN</code> </para> </li> <li> <para> Logical operators: <code>AND | OR | NOT</code> </para> </li> </ul> <para> For more information on condition expressions, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ConditionExpression</i> replaces the legacy <i>ConditionalOperator</i> and <i>Expected</i> parameters. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.Expected"> <summary> Gets and sets the property Expected. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A map of attribute/condition pairs. <i>Expected</i> provides a conditional block for the <i>PutItem</i> operation. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> <para> Each element of <i>Expected</i> consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each <i>Expected</i> element, the result of the evaluation is either true or false. </para> <para> If you specify more than one element 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.) </para> <para> If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails. </para> <para> <i>Expected</i> contains the following: </para> <ul> <li> <para> <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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> The following are descriptions of each comparison operator. </para> <ul> <li> <para> <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NE</code> : Not equal. <code>NE</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <i>false</i>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>CONTAINS</code> : Checks for a subsequence, or value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set. </para> <para> CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set. </para> <para> NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>IN</code> : Checks for matching elements within two sets. </para> <para> <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> </li> </ul> <para> For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>: </para> <ul> <li> <para> <i>Value</i> - A value for DynamoDB to compare with an attribute. </para> </li> <li> <para> <i>Exists</i> - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: </para> <ul> <li> <para> If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. </para> </li> <li> <para> If <i>Exists</i> is <code>false</code>, 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. </para> </li> </ul> <para> Note that the default value for <i>Exists</i> is <code>true</code>. </para> </li> </ul> <para> The <i>Value</i> and <i>Exists</i> parameters are incompatible with <i>AttributeValueList</i> and <i>ComparisonOperator</i>. Note that if you use both sets of parameters at once, DynamoDB will return a <i>ValidationException</i> exception. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. <para> One or more values that can be substituted in an expression. </para> <para> Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <i>ProductStatus</i> attribute was one of the following: </para> <para> <code>Available | Backordered | Discontinued</code> </para> <para> You would first need to specify <i>ExpressionAttributeValues</i> as follows: </para> <para> <code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code> </para> <para> You could then use these values in an expression, such as this: </para> <para> <code>ProductStatus IN (:avail, :back, :disc)</code> </para> <para> For more information on expression attribute values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.Item"> <summary> Gets and sets the property Item. <para> 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. </para> <para> You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. </para> <para> 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. </para> <para> For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> Each element in the <i>Item</i> map is an <i>AttributeValue</i> object. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnItemCollectionMetrics"> <summary> Gets and sets the property ReturnItemCollectionMetrics. <para> Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.ReturnValues"> <summary> Gets and sets the property ReturnValues. <para> 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: </para> <ul> <li> <para> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </para> </li> <li> <para> <code>ALL_OLD</code> - If <i>PutItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table to contain the item. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.PutItemResponse"> <summary> Configuration for accessing Amazon PutItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.PutItemResult"> <summary> Represents the output of a <i>PutItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.Attributes"> <summary> Gets and sets the property Attributes. <para> The attribute values as they appeared before the <i>PutItem</i> operation, but only if <i>ReturnValues</i> is specified as <code>ALL_OLD</code> in the request. Each element consists of an attribute name and an attribute value. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.PutItemResult.ItemCollectionMetrics"> <summary> Gets and sets the property ItemCollectionMetrics. <para> Information about item collections, if any, that were affected by the operation. <i>ItemCollectionMetrics</i> is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response. </para> <para> Each <i>ItemCollectionMetrics</i> element consists of: </para> <ul> <li> <para> <i>ItemCollectionKey</i> - The partition key value of the item collection. This is the same as the partition key value of the item itself. </para> </li> <li> <para> <i>SizeEstimateRange</i> - An estimate of item collection size, in gigabytes. This value 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. </para> <para> The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate. </para> </li> </ul> </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.PutRequest"> <summary> Represents a request to perform a <i>PutItem</i> operation on an item. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.PutRequest.#ctor(System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue})"> <summary> Instantiates PutRequest with the parameterized properties </summary> <param name="item">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.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.PutRequest.Item"> <summary> Gets and sets the property Item. <para> 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. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryRequest"> <summary> Container for the parameters to the Query operation. A <i>Query</i> operation uses the primary key of a table or a secondary index to directly access items from that table or index. <para> Use the <i>KeyConditionExpression</i> parameter to provide a specific value for the partition key. The <i>Query</i> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <i>Query</i> operation by specifying a sort key value and a comparison operator in <i>KeyConditionExpression</i>. You can use the <i>ScanIndexForward</i> parameter to get results in forward or reverse order, by sort key. </para> <para> Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </para> <para> If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <i>LastEvaluatedKey</i> element to continue the query in a subsequent operation. Unlike a <i>Scan</i> operation, a <i>Query</i> operation never returns both an empty result set and a <i>LastEvaluatedKey</i> value. <i>LastEvaluatedKey</i> is only provided if the results exceed 1 MB, or if you have used the <i>Limit</i> parameter. </para> <para> You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <i>ConsistentRead</i> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <i>ConsistentRead</i> when querying a global secondary index. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.QueryRequest.#ctor(System.String)"> <summary> Instantiates QueryRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the requested items. </param> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.AttributesToGet"> <summary> Gets and sets the property AttributesToGet. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> <para> This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. </para> </important> <para> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. </para> <para> 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> <para> 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 <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) </para> <para> If you query 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. </para> <para> If you query 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ConditionalOperator"> <summary> Gets and sets the property ConditionalOperator. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A logical operator to apply to the conditions in a <i>QueryFilter</i> map: </para> <ul> <li> <para> <code>AND</code> - If all of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> <li> <para> <code>OR</code> - If at least one of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> </ul> <para> If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default. </para> <para> The operation will succeed only if the entire map evaluates to true. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ConsistentRead"> <summary> Gets and sets the property ConsistentRead. <para> Determines the read consistency model: If set to <code>true</code>, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. </para> <para> Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with <i>ConsistentRead</i> set to <code>true</code>, you will receive a <i>ValidationException</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ExclusiveStartKey"> <summary> Gets and sets the property ExclusiveStartKey. <para> 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. </para> <para> The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. <para> One or more values that can be substituted in an expression. </para> <para> Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <i>ProductStatus</i> attribute was one of the following: </para> <para> <code>Available | Backordered | Discontinued</code> </para> <para> You would first need to specify <i>ExpressionAttributeValues</i> as follows: </para> <para> <code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code> </para> <para> You could then use these values in an expression, such as this: </para> <para> <code>ProductStatus IN (:avail, :back, :disc)</code> </para> <para> For more information on expression attribute values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.FilterExpression"> <summary> Gets and sets the property FilterExpression. <para> A string that contains conditions that DynamoDB applies after the <i>Query</i> operation, but before the data is returned to you. Items that do not satisfy the <i>FilterExpression</i> criteria are not returned. </para> <note> <para> A <i>FilterExpression</i> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>FilterExpression</i> replaces the legacy <i>QueryFilter</i> and <i>ConditionalOperator</i> parameters. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the <i>IndexName</i> parameter, you must also provide <i>TableName.</i> </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.KeyConditionExpression"> <summary> Gets and sets the property KeyConditionExpression. <para> The condition that specifies the key value(s) for items to be retrieved by the <i>Query</i> action. </para> <para> The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. <i>Query</i> can use <i>KeyConditionExpression</i> to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values. </para> <para> The partition key equality test is required, and must be specified in the following format: </para> <para> <code>partitionKeyName</code> <i>=</i> <code>:partitionkeyval</code> </para> <para> If you also want to provide a condition for the sort key, it must be combined using <i>AND</i> with the condition for the sort key. Following is an example, using the <b>=</b> comparison operator for the sort key: </para> <para> <code>partitionKeyName</code> <i>=</i> <code>:partitionkeyval</code> <i>AND</i> <code>sortKeyName</code> <i>=</i> <code>:sortkeyval</code> </para> <para> Valid comparisons for the sort key condition are as follows: </para> <ul> <li> <para> <code>sortKeyName</code> <i>=</i> <code>:sortkeyval</code> - true if the sort key value is equal to <code>:sortkeyval</code>. </para> </li> <li> <para> <code>sortKeyName</code> <i><![CDATA[<]]></i> <code>:sortkeyval</code> - true if the sort key value is less than <code>:sortkeyval</code>. </para> </li> <li> <para> <code>sortKeyName</code> <i><![CDATA[<]]>=</i> <code>:sortkeyval</code> - true if the sort key value is less than or equal to <code>:sortkeyval</code>. </para> </li> <li> <para> <code>sortKeyName</code> <i><![CDATA[>]]></i> <code>:sortkeyval</code> - true if the sort key value is greater than <code>:sortkeyval</code>. </para> </li> <li> <para> <code>sortKeyName</code> <i><![CDATA[>]]>= </i><code>:sortkeyval</code> - true if the sort key value is greater than or equal to <code>:sortkeyval</code>. </para> </li> <li> <para> <code>sortKeyName</code> <i>BETWEEN</i> <code>:sortkeyval1</code> <i>AND</i> <code>:sortkeyval2</code> - true if the sort key value is greater than or equal to <code>:sortkeyval1</code>, and less than or equal to <code>:sortkeyval2</code>. </para> </li> <li> <para> <i>begins_with (</i><code>sortKeyName</code>, <code>:sortkeyval</code><i>)</i> - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name <code>begins_with</code> is case-sensitive. </para> </li> </ul> <para> Use the <i>ExpressionAttributeValues</i> parameter to replace tokens such as <code>:partitionval</code> and <code>:sortval</code> with actual values at runtime. </para> <para> You can optionally use the <i>ExpressionAttributeNames</i> parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following <i>KeyConditionExpression</i> parameter causes an error because <i>Size</i> is a reserved word: </para> <ul> <li> <code>Size = :myval</code> </li> </ul> <para> To work around this, define a placeholder (such a <code>#S</code>) to represent the attribute name <i>Size</i>. <i>KeyConditionExpression</i> then is as follows: </para> <ul> <li> <code>#S = :myval</code> </li> </ul> <para> For a list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> For more information on <i>ExpressionAttributeNames</i> and <i>ExpressionAttributeValues</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html">Using Placeholders for Attribute Names and Values</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>KeyConditionExpression</i> replaces the legacy <i>KeyConditions</i> parameter. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.KeyConditions"> <summary> Gets and sets the property KeyConditions. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>KeyConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> The selection criteria for the query. For a query on a table, you can have conditions only on the table primary key attributes. You must provide the partition key name and value as an <code>EQ</code> condition. You can optionally provide a second condition, referring to the sort key. </para> <note> <para> If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a <i>FilterExpression</i> or <i>QueryFilter</i> is present, it will be applied after the items are retrieved. </para> </note> <para> For a query on an index, you can have conditions only on the index key attributes. You must provide the index partition key name and value as an <code>EQ</code> condition. You can optionally provide a second condition, referring to the index sort key. </para> <para> Each <i>KeyConditions</i> element consists of an attribute name to compare, along with the following: </para> <ul> <li> <para> <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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on. </para> <para> For <i>KeyConditions</i>, only the following comparison operators are supported: </para> <para> <code>EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN</code> </para> <para> The following are descriptions of these comparison operators. </para> <ul> <li> <para> <code>EQ</code> : Equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one specified in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> </li> </ul> <para> For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.Limit"> <summary> Gets and sets the property Limit. <para> 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 key in <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 key in <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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ProjectionExpression"> <summary> Gets and sets the property ProjectionExpression. <para> A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. </para> <para> 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. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ProjectionExpression</i> replaces the legacy <i>AttributesToGet</i> parameter. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.QueryFilter"> <summary> Gets and sets the property QueryFilter. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A condition that evaluates the query results after the items are read and returns only the desired values. </para> <para> This parameter does not support attributes of type List or Map. </para> <note> <para> A <i>QueryFilter</i> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. </para> </note> <para> If you provide 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.) </para> <para> Note that <i>QueryFilter</i> does not allow key attributes. You cannot define a filter condition on a partition key or a sort key. </para> <para> Each <i>QueryFilter</i> element consists of an attribute name to compare, along with the following: </para> <ul> <li> <para> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i>. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> <para> For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> For complete descriptions of all comparison operators, see the <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a> data type. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.ScanIndexForward"> <summary> Gets and sets the property ScanIndexForward. <para> Specifies the order for index traversal: If <code>true</code> (default), the traversal is performed in ascending order; if <code>false</code>, the traversal is performed in descending order. </para> <para> Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned. </para> <para> If <i>ScanIndexForward</i> is <code>true</code>, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If <i>ScanIndexForward</i> is <code>false</code>, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.Select"> <summary> Gets and sets the property Select. <para> 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. </para> <ul> <li> <para> <code>ALL_ATTRIBUTES</code> - Returns all of the item attributes from the specified table or index. If you query 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. </para> </li> <li> <para> <code>ALL_PROJECTED_ATTRIBUTES</code> - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying <code>ALL_ATTRIBUTES</code>. </para> </li> <li> <para> <code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. </para> </li> <li> <para> <code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <i>AttributesToGet</i>. This return value is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>. </para> <para> If you query 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. </para> <para> If you query 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> </li> </ul> <para> If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code> when accessing a table, and <code>ALL_PROJECTED_ATTRIBUTES</code> when accessing an index. You cannot use both <i>Select</i> and <i>AttributesToGet</i> together in a single request, unless the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) </para> <note> <para> If you use the <i>ProjectionExpression</i> parameter, then the value for <i>Select</i> can only be <code>SPECIFIC_ATTRIBUTES</code>. Any other value for <i>Select</i> will return an error. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table containing the requested items. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryResponse"> <summary> Configuration for accessing Amazon Query service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.QueryResult"> <summary> Represents the output of a <i>Query</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.Count"> <summary> Gets and sets the property Count. <para> The number of items in the response. </para> <para> If you used a <i>QueryFilter</i> in the request, then <i>Count</i> is the number of items returned after the filter was applied, and <i>ScannedCount</i> is the number of matching items before the filter was applied. </para> <para> If you did not use a filter in the request, then <i>Count</i> and <i>ScannedCount</i> are the same. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.Items"> <summary> Gets and sets the property Items. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.LastEvaluatedKey"> <summary> Gets and sets the property LastEvaluatedKey. <para> 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. </para> <para> If <i>LastEvaluatedKey</i> is empty, then the "last page" of results has been processed and there is no more data to be retrieved. </para> <para> If <i>LastEvaluatedKey</i> is not empty, it 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 empty. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.QueryResult.ScannedCount"> <summary> Gets and sets the property ScannedCount. <para> The number of items evaluated, before any <i>QueryFilter</i> is 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 <i>Amazon DynamoDB Developer Guide</i>. </para> <para> If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>. </para> </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.Record"> <summary> A description of a unique event within a stream. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.AwsRegion"> <summary> Gets and sets the property AwsRegion. <para> The region in which the <i>GetRecords</i> request was received. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.Dynamodb"> <summary> Gets and sets the property Dynamodb. <para> The main body of the stream record, containing all of the DynamoDB-specific fields. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.EventID"> <summary> Gets and sets the property EventID. <para> A globally unique identifier for the event that was recorded in this stream record. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.EventName"> <summary> Gets and sets the property EventName. <para> The type of data modification that was performed on the DynamoDB table: </para> <ul> <li> <para> <code>INSERT</code> - a new item was added to the table. </para> </li> <li> <para> <code>MODIFY</code> - one or more of the item's attributes were updated. </para> </li> <li> <para> <code>REMOVE</code> - the item was deleted from the table </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.EventSource"> <summary> Gets and sets the property EventSource. <para> The AWS service from which the stream record originated. For DynamoDB Streams, this is <i>aws:dynamodb</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Record.EventVersion"> <summary> Gets and sets the property EventVersion. <para> The version number of the stream record format. Currently, this is <i>1.0</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ResourceInUseException"> <summary> DynamoDB 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> DynamoDB 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. The <i>Scan</i> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <i>ScanFilter</i> operation. <para> If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <i>LastEvaluatedKey</i> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </para> <para> By default, <i>Scan</i> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <i>Scan</i> operation by providing the <i>Segment</i> and <i>TotalSegments</i> parameters. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> By default, <i>Scan</i> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <i>ConsistentRead</i> parameter to <i>true</i>. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.ScanRequest.#ctor(System.String)"> <summary> Instantiates ScanRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.AttributesToGet"> <summary> Gets and sets the property AttributesToGet. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ProjectionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> <para> This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map. </para> </important> <para> The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. </para> <para> 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> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ConditionalOperator"> <summary> Gets and sets the property ConditionalOperator. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A logical operator to apply to the conditions in a <i>ScanFilter</i> map: </para> <ul> <li> <para> <code>AND</code> - If all of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> <li> <para> <code>OR</code> - If at least one of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> </ul> <para> If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default. </para> <para> The operation will succeed only if the entire map evaluates to true. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ConsistentRead"> <summary> Gets and sets the property ConsistentRead. <para> A Boolean value that determines the read consistency model during the scan: </para> <ul> <li> <para> If <i>ConsistentRead</i> is <code>false</code>, then the data returned from <i>Scan</i> might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem). </para> </li> <li> <para> If <i>ConsistentRead</i> is <code>true</code>, then all of the write operations that completed before the <i>Scan</i> began are guaranteed to be contained in the <i>Scan</i> response. </para> </li> </ul> <para> The default setting for <i>ConsistentRead</i> is <code>false</code>. </para> <para> The <i>ConsistentRead</i> parameter is not supported on global secondary indexes. If you scan a global secondary index with <i>ConsistentRead</i> set to true, you will receive a <i>ValidationException</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ExclusiveStartKey"> <summary> Gets and sets the property ExclusiveStartKey. <para> 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. </para> <para> The data type for <i>ExclusiveStartKey</i> must be String, Number or Binary. No set data types are allowed. </para> <para> 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>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. <para> One or more values that can be substituted in an expression. </para> <para> Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <i>ProductStatus</i> attribute was one of the following: </para> <para> <code>Available | Backordered | Discontinued</code> </para> <para> You would first need to specify <i>ExpressionAttributeValues</i> as follows: </para> <para> <code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code> </para> <para> You could then use these values in an expression, such as this: </para> <para> <code>ProductStatus IN (:avail, :back, :disc)</code> </para> <para> For more information on expression attribute values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.FilterExpression"> <summary> Gets and sets the property FilterExpression. <para> A string that contains conditions that DynamoDB applies after the <i>Scan</i> operation, but before the data is returned to you. Items that do not satisfy the <i>FilterExpression</i> criteria are not returned. </para> <note> <para> A <i>FilterExpression</i> is applied after the items have already been read; the process of filtering does not consume any additional read capacity units. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults">Filter Expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>FilterExpression</i> replaces the legacy <i>ScanFilter</i> and <i>ConditionalOperator</i> parameters. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Limit"> <summary> Gets and sets the property Limit. <para> 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 key in <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 key in <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 <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ProjectionExpression"> <summary> Gets and sets the property ProjectionExpression. <para> A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. </para> <para> 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. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ProjectionExpression</i> replaces the legacy <i>AttributesToGet</i> parameter. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.ScanFilter"> <summary> Gets and sets the property ScanFilter. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>FilterExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A condition that evaluates the scan results and returns only the desired values. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> <para> 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.) </para> <para> Each <i>ScanFilter</i> element consists of an attribute name to compare, along with the following: </para> <ul> <li> <para> <i>AttributeValueList</i> - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in <i>ComparisonOperator</i> . </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters">http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> <para> For information on specifying data types in JSON, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html">JSON Data Format</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> For complete descriptions of all comparison operators, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Condition.html">Condition</a>. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Segment"> <summary> Gets and sets the property Segment. <para> For a parallel <i>Scan</i> request, <i>Segment</i> identifies an individual segment to be scanned by an application worker. </para> <para> Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a <i>Segment</i> value of 0, the second thread specifies 1, and so on. </para> <para> 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. </para> <para> The value for <i>Segment</i> must be greater than or equal to 0, and less than the value provided for <i>TotalSegments</i>. </para> <para> If you provide <i>Segment</i>, you must also provide <i>TotalSegments</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.Select"> <summary> Gets and sets the property Select. <para> The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, or the count of matching items. </para> <ul> <li> <para> <code>ALL_ATTRIBUTES</code> - Returns all of the item attributes. </para> </li> <li> <para> <code>COUNT</code> - Returns the number of matching items, rather than the matching items themselves. </para> </li> <li> <para> <code>SPECIFIC_ATTRIBUTES</code> - Returns only the attributes listed in <i>AttributesToGet</i>. This return value is equivalent to specifying <i>AttributesToGet</i> without specifying any value for <i>Select</i>. </para> </li> </ul> <para> If neither <i>Select</i> nor <i>AttributesToGet</i> are specified, DynamoDB defaults to <code>ALL_ATTRIBUTES</code>. You cannot use both <i>AttributesToGet</i> and <i>Select</i> together in a single request, unless the value for <i>Select</i> is <code>SPECIFIC_ATTRIBUTES</code>. (This usage is equivalent to specifying <i>AttributesToGet</i> without any value for <i>Select</i>.) </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanRequest.TotalSegments"> <summary> Gets and sets the property TotalSegments. <para> 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 use four application threads to scan a table or an index, specify a <i>TotalSegments</i> value of 4. </para> <para> The value for <i>TotalSegments</i> must be greater than or equal to 1, and less than or equal to 1000000. If you specify a <i>TotalSegments</i> value of 1, the <i>Scan</i> operation will be sequential rather than parallel. </para> <para> If you specify <i>TotalSegments</i>, you must also specify <i>Segment</i>. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ScanResponse"> <summary> Configuration for accessing Amazon Scan service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.ScanResult"> <summary> Represents the output of a <i>Scan</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.Count"> <summary> Gets and sets the property Count. <para> The number of items in the response. </para> <para> If you set <i>ScanFilter</i> in the request, then <i>Count</i> is the number of items returned after the filter was applied, and <i>ScannedCount</i> is the number of matching items before the filter was applied. </para> <para> If you did not use a filter in the request, then <i>Count</i> is the same as <i>ScannedCount</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.Items"> <summary> Gets and sets the property Items. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.LastEvaluatedKey"> <summary> Gets and sets the property LastEvaluatedKey. <para> 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. </para> <para> If <i>LastEvaluatedKey</i> is empty, then the "last page" of results has been processed and there is no more data to be retrieved. </para> <para> If <i>LastEvaluatedKey</i> is not empty, it 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 empty. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.ScanResult.ScannedCount"> <summary> Gets and sets the property ScannedCount. <para> The number of items evaluated, before any <i>ScanFilter</i> is 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 <i>Amazon DynamoDB Developer Guide</i>. </para> <para> If you did not use a filter in the request, then <i>ScannedCount</i> is the same as <i>Count</i>. </para> </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.SequenceNumberRange"> <summary> The beginning and ending sequence numbers for the stream records contained within a shard. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.SequenceNumberRange.EndingSequenceNumber"> <summary> Gets and sets the property EndingSequenceNumber. <para> The last sequence number. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.SequenceNumberRange.StartingSequenceNumber"> <summary> Gets and sets the property StartingSequenceNumber. <para> The first sequence number. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Shard"> <summary> A uniquely identified group of stream records within a stream. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Shard.ParentShardId"> <summary> Gets and sets the property ParentShardId. <para> The shard ID of the current shard's parent. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Shard.SequenceNumberRange"> <summary> Gets and sets the property SequenceNumberRange. <para> The range of possible sequence numbers for the shard. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.Shard.ShardId"> <summary> Gets and sets the property ShardId. <para> The system-generated identifier for this shard. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.StreamDescription"> <summary> Represents all of the data describing a particular stream. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.CreationRequestDateTime"> <summary> Gets and sets the property CreationRequestDateTime. <para> The date and time when the request to create this stream was issued. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The key attribute(s) of the stream's DynamoDB table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.LastEvaluatedShardId"> <summary> Gets and sets the property LastEvaluatedShardId. <para> The shard ID 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. </para> <para> If <code>LastEvaluatedShardId</code> is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved. </para> <para> If <code>LastEvaluatedShardId</code> is not empty, it 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 <code>LastEvaluatedShardId</code> is empty. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.Shards"> <summary> Gets and sets the property Shards. <para> The shards that comprise the stream. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.StreamArn"> <summary> Gets and sets the property StreamArn. <para> The Amazon Resource Name (ARN) for the stream. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.StreamLabel"> <summary> Gets and sets the property StreamLabel. <para> A timestamp, in ISO 8601 format, for this stream. </para> <para> Note that <i>LatestStreamLabel</i> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: </para> <ul> <li> <para> the AWS customer ID. </para> </li> <li> <para> the table name </para> </li> <li> <para> the <i>StreamLabel</i> </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.StreamStatus"> <summary> Gets and sets the property StreamStatus. <para> Indicates the current status of the stream: </para> <ul> <li> <para> <code>ENABLING</code> - Streams is currently being enabled on the DynamoDB table. </para> </li> <li> <para> <code>ENABLING</code> - the stream is enabled. </para> </li> <li> <para> <code>DISABLING</code> - Streams is currently being disabled on the DynamoDB table. </para> </li> <li> <para> <code>DISABLED</code> - the stream is disabled. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.StreamViewType"> <summary> Gets and sets the property StreamViewType. <para> Indicates the format of the records within this stream: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - only the key attributes of items that were modified in the DynamoDB table. </para> </li> <li> <para> <code>NEW_IMAGE</code> - entire item from the table, as it appeared after they were modified. </para> </li> <li> <para> <code>OLD_IMAGE</code> - entire item from the table, as it appeared before they were modified. </para> </li> <li> <para> <code>NEW_AND_OLD_IMAGES</code> - both the new and the old images of the items from the table. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamDescription.TableName"> <summary> Gets and sets the property TableName. <para> The DynamoDB table with which the stream is associated. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.StreamRecord"> <summary> A description of a single data modification that was performed on an item in a DynamoDB table. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.Keys"> <summary> Gets and sets the property Keys. <para> The primary key attribute(s) for the DynamoDB item that was modified. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.NewImage"> <summary> Gets and sets the property NewImage. <para> The item in the DynamoDB table as it appeared after it was modified. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.OldImage"> <summary> Gets and sets the property OldImage. <para> The item in the DynamoDB table as it appeared before it was modified. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.SequenceNumber"> <summary> Gets and sets the property SequenceNumber. <para> The sequence number of the stream record. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.SizeBytes"> <summary> Gets and sets the property SizeBytes. <para> The size of the stream record, in bytes. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamRecord.StreamViewType"> <summary> Gets and sets the property StreamViewType. <para> The type of data from the modified DynamoDB item that was captured in this stream record: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - only the key attributes of the modified item. </para> </li> <li> <para> <code>NEW_IMAGE</code> - the entire item, as it appears after it was modified. </para> </li> <li> <para> <code>OLD_IMAGE</code> - the entire item, as it appeared before it was modified. </para> </li> <li> <para> <code>NEW_AND_OLD_IMAGES</code> — both the new and the old item images of the item. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.StreamSpecification"> <summary> Represents the DynamoDB Streams configuration for a table in DynamoDB. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamSpecification.StreamEnabled"> <summary> Gets and sets the property StreamEnabled. <para> Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamSpecification.StreamViewType"> <summary> Gets and sets the property StreamViewType. <para> The DynamoDB Streams settings for the table. These settings consist of: </para> <ul> <li> <para> <i>StreamEnabled</i> - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. </para> </li> <li> <para> <i>StreamViewType</i> - When an item in the table is modified, <i>StreamViewType</i> determines what information is written to the stream for this table. Valid values for <i>StreamViewType</i> are: </para> <ul> <li> <para> <i>KEYS_ONLY</i> - Only the key attributes of the modified item are written to the stream. </para> </li> <li> <para> <i>NEW_IMAGE</i> - The entire item, as it appears after it was modified, is written to the stream. </para> </li> <li> <para> <i>OLD_IMAGE</i> - The entire item, as it appeared before it was modified, is written to the stream. </para> </li> <li> <para> <i>NEW_AND_OLD_IMAGES</i> - Both the new and the old item images of the item are written to the stream. </para> </li> </ul> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.StreamSummary"> <summary> Represents all of the data describing a particular stream. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamSummary.StreamArn"> <summary> Gets and sets the property StreamArn. <para> The Amazon Resource Name (ARN) for the stream. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamSummary.StreamLabel"> <summary> Gets and sets the property StreamLabel. <para> A timestamp, in ISO 8601 format, for this stream. </para> <para> Note that <i>LatestStreamLabel</i> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: </para> <ul> <li> <para> the AWS customer ID. </para> </li> <li> <para> the table name </para> </li> <li> <para> the <i>StreamLabel</i> </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.StreamSummary.TableName"> <summary> Gets and sets the property TableName. <para> The DynamoDB table with which the stream is associated. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.TableDescription"> <summary> Represents the properties of a table. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.TableDescription.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.AttributeDefinitions"> <summary> Gets and sets the property AttributeDefinitions. <para> An array of <i>AttributeDefinition</i> objects. Each of these objects describes one attribute in the table and index key schema. </para> <para> Each <i>AttributeDefinition</i> object in this array is composed of: </para> <ul> <li> <para> <i>AttributeName</i> - The name of the attribute. </para> </li> <li> <para> <i>AttributeType</i> - The data type for the attribute. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.CreationDateTime"> <summary> Gets and sets the property CreationDateTime. <para> The date and time when the table was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.GlobalSecondaryIndexes"> <summary> Gets and sets the property GlobalSecondaryIndexes. <para> The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: </para> <ul> <li> <para> <i>Backfilling</i> - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a <i>CreateTable</i> operation.) </para> </li> <li> <para> <i>IndexName</i> - The name of the global secondary index. </para> </li> <li> <para> <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. </para> </li> <li> <para> <i>IndexStatus</i> - The current status of the global secondary index: </para> <ul> <li> <para> <i>CREATING</i> - The index is being created. </para> </li> <li> <para> <i>UPDATING</i> - The index is being updated. </para> </li> <li> <para> <i>DELETING</i> - The index is being deleted. </para> </li> <li> <para> <i>ACTIVE</i> - The index is ready for use. </para> </li> </ul> </li> <li> <para> <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. </para> </li> <li> <para> <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 partition key as the table. </para> </li> <li> <para> <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: </para> <ul> <li> <para> <i>ProjectionType</i> - One of the following: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index. </para> </li> <li> <para> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </para> </li> <li> <para> <code>ALL</code> - All of the table attributes are projected into the index. </para> </li> </ul> </li> <li> <para> <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 provided 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. </para> </li> </ul> </li> <li> <para> <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. </para> </li> </ul> <para> If the table is in the <code>DELETING</code> state, no information about indexes will be returned. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.ItemCount"> <summary> Gets and sets the property ItemCount. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.KeySchema"> <summary> Gets and sets the property KeySchema. <para> The primary key structure for the table. Each <i>KeySchemaElement</i> consists of: </para> <ul> <li> <para> <i>AttributeName</i> - The name of the attribute. </para> </li> <li> <para> <i>KeyType</i> - The role of the attribute: </para> . <ul> <li> <para> <code>HASH</code> - partition key </para> </li> <li> <para> <code>RANGE</code> - sort key </para> </li> </ul> <note> <para> The partition key of an item is also known as its <i>hash attribute</i>. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. </para> <para> The sort key of an item is also known as its <i>range attribute</i>. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. </para> </note> </li> </ul> <para> For more information about primary keys, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.LatestStreamArn"> <summary> Gets and sets the property LatestStreamArn. <para> The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.LatestStreamLabel"> <summary> Gets and sets the property LatestStreamLabel. <para> A timestamp, in ISO 8601 format, for this stream. </para> <para> Note that <i>LatestStreamLabel</i> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: </para> <ul> <li> <para> the AWS customer ID. </para> </li> <li> <para> the table name. </para> </li> <li> <para> the <i>StreamLabel</i>. </para> </li> </ul> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.LocalSecondaryIndexes"> <summary> Gets and sets the property LocalSecondaryIndexes. <para> Represents one or more local secondary indexes on the table. Each index is scoped to a given partition 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: </para> <ul> <li> <para> <i>IndexName</i> - The name of the local secondary index. </para> </li> <li> <para> <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 partition key as the table. </para> </li> <li> <para> <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: </para> <ul> <li> <para> <i>ProjectionType</i> - One of the following: </para> <ul> <li> <para> <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the index. </para> </li> <li> <para> <code>INCLUDE</code> - Only the specified table attributes are projected into the index. The list of projected attributes are in <i>NonKeyAttributes</i>. </para> </li> <li> <para> <code>ALL</code> - All of the table attributes are projected into the index. </para> </li> </ul> </li> <li> <para> <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 provided 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. </para> </li> </ul> </li> <li> <para> <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. </para> </li> <li> <para> <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. </para> </li> </ul> <para> If the table is in the <code>DELETING</code> state, no information about indexes will be returned. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. <para> 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="P:Amazon.DynamoDBv2.Model.TableDescription.StreamSpecification"> <summary> Gets and sets the property StreamSpecification. <para> The current DynamoDB Streams configuration for the table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableArn"> <summary> Gets and sets the property TableArn. <para> The Amazon Resource Name (ARN) that uniquely identifies the table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableSizeBytes"> <summary> Gets and sets the property TableSizeBytes. <para> 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. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.TableDescription.TableStatus"> <summary> Gets and sets the property TableStatus. <para> The current state of the table: </para> <ul> <li> <para> <i>CREATING</i> - The table is being created. </para> </li> <li> <para> <i>UPDATING</i> - The table is being updated. </para> </li> <li> <para> <i>DELETING</i> - The table is being deleted. </para> </li> <li> <para> <i>ACTIVE</i> - The table is ready for use. </para> </li> </ul> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.TrimmedDataAccessException"> <summary> DynamoDBStreams exception </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.TrimmedDataAccessException.#ctor(System.String)"> <summary> Constructs a new TrimmedDataAccessException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction"> <summary> Represents the new provisioned throughput settings to be applied to a global secondary index. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.IndexName"> <summary> Gets and sets the property IndexName. <para> The name of the global secondary index to be updated. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateGlobalSecondaryIndexAction.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemRequest"> <summary> Container for the parameters to the UpdateItem operation. Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values). <para> You can also return the item's attribute values in the same <i>UpdateItem</i> operation using the <i>ReturnValues</i> parameter. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate})"> <summary> Instantiates UpdateItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateItemRequest.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValue},System.Collections.Generic.Dictionary{System.String,Amazon.DynamoDBv2.Model.AttributeValueUpdate},Amazon.DynamoDBv2.ReturnValue)"> <summary> Instantiates UpdateItemRequest with the parameterized properties </summary> <param name="tableName">The name of the table containing the item to update. </param> <param name="key">The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.</param> <param name="attributeUpdates"><important> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </important> The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the <i>AttributesDefinition</i> of the table description. You can use <i>UpdateItem</i> to update any non-key attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: <ul> <li> <i>Value</i> - The new value, if applicable, for this attribute. </li> <li> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. If an item with the specified primary key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </li> <li> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </li> <li> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: <ul> <li> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. <note> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </note> </li> <li> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </li> </ul> </li> </ul> If no item with the specified key is found in the table, the following values perform the following actions: <ul> <li> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </li> <li> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </li> <li> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </li> </ul> </li> </ul> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</param> <param name="returnValues">Use <i>ReturnValues</i> if you want to get the item attributes as they appeared either before or after they were updated. For <i>UpdateItem</i>, the valid values are: <ul> <li> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </li> <li> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </li> <li> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </li> <li> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </li> <li> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </li> </ul> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. Values returned are strongly consistent</param> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.AttributeUpdates"> <summary> Gets and sets the property AttributeUpdates. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>UpdateExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> <para> This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements. </para> </important> <para> 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. </para> <para> Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a <i>ValidationException</i> exception. </para> <para> Each <i>AttributeUpdates</i> element consists of an attribute name to modify, along with the following: </para> <ul> <li> <para> <i>Value</i> - The new value, if applicable, for this attribute. </para> </li> <li> <para> <i>Action</i> - A value that specifies how to perform the update. This action is only valid for an existing attribute whose data type is Number or is a set; do not use <code>ADD</code> for other data types. </para> <para> If an item with the specified primary key is found in the table, the following values perform the following actions: </para> <ul> <li> <para> <code>PUT</code> - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. </para> </li> <li> <para> <code>DELETE</code> - Removes the attribute and its value, if no value is specified for <code>DELETE</code>. The data type of the specified value must match the existing value's data type. </para> <para> If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </para> </li> <li> <para> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: </para> <ul> <li> <para> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. </para> <note> <para> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value. </para> <para> Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute, with a value of <code>3</code>. </para> </note> </li> <li> <para> If the existing data type is a set, and if <i>Value</i> is also a set, then <i>Value</i> is appended to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. </para> <para> Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, <i>Value</i> must also be a set of strings. </para> </li> </ul> </li> </ul> <para> If no item with the specified key is found in the table, the following values perform the following actions: </para> <ul> <li> <para> <code>PUT</code> - Causes DynamoDB to create a new item with the specified primary key, and then adds the attribute. </para> </li> <li> <para> <code>DELETE</code> - Nothing happens, because attributes cannot be deleted from a nonexistent item. The operation succeeds, but DynamoDB does not create a new item. </para> </li> <li> <para> <code>ADD</code> - Causes DynamoDB to create an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are Number and Number Set. </para> </li> </ul> </li> </ul> <para> If you provide any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ConditionalOperator"> <summary> Gets and sets the property ConditionalOperator. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i>ConditionExpression</i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A logical operator to apply to the conditions in the <i>Expected</i> map: </para> <ul> <li> <para> <code>AND</code> - If all of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> <li> <para> <code>OR</code> - If at least one of the conditions evaluate to true, then the entire map evaluates to true. </para> </li> </ul> <para> If you omit <i>ConditionalOperator</i>, then <code>AND</code> is the default. </para> <para> The operation will succeed only if the entire map evaluates to true. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ConditionExpression"> <summary> Gets and sets the property ConditionExpression. <para> A condition that must be satisfied in order for a conditional update to succeed. </para> <para> An expression can contain any of the following: </para> <ul> <li> <para> Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </para> <para> These function names are case-sensitive. </para> </li> <li> <para> Comparison operators: <code> = | <![CDATA[<]]><![CDATA[>]]> | <![CDATA[<]]> | <![CDATA[>]]> | <![CDATA[<]]>= | <![CDATA[>]]>= | BETWEEN | IN</code> </para> </li> <li> <para> Logical operators: <code>AND | OR | NOT</code> </para> </li> </ul> <para> For more information on condition expressions, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>ConditionExpression</i> replaces the legacy <i>ConditionalOperator</i> and <i>Expected</i> parameters. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.Expected"> <summary> Gets and sets the property Expected. <important> <para> This is a legacy parameter, for backward compatibility. New applications should use <i> ConditionExpression </i> instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a <i>ValidationException</i> exception. </para> </important> <para> A map of attribute/condition pairs. <i>Expected</i> provides a conditional block for the <i>UpdateItem</i> operation. </para> <para> Each element of <i>Expected</i> consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each <i>Expected</i> element, the result of the evaluation is either true or false. </para> <para> If you specify more than one element 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.) </para> <para> If the <i>Expected</i> map evaluates to true, then the conditional operation succeeds; otherwise, it fails. </para> <para> <i>Expected</i> contains the following: </para> <ul> <li> <para> <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. </para> <para> For type Number, value comparisons are numeric. </para> <para> String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, <code>a</code> is greater than <code>A</code>, and <code>a</code> is greater than <code>B</code>. For a list of code values, see <a href="http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters" >http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters</a>. </para> <para> For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. </para> </li> <li> <para> <i>ComparisonOperator</i> - A comparator for evaluating attributes in the <i>AttributeValueList</i>. When performing the comparison, DynamoDB uses strongly consistent reads. </para> <para> The following comparison operators are available: </para> <para> <code>EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN</code> </para> <para> The following are descriptions of each comparison operator. </para> <ul> <li> <para> <code>EQ</code> : Equal. <code>EQ</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NE</code> : Not equal. <code>NE</code> is supported for all datatypes, including lists and maps. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an <i>AttributeValue</i> of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not equal <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LE</code> : Less than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>LT</code> : Less than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GE</code> : Greater than or equal. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>GT</code> : Greater than. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If an item contains an <i>AttributeValue</i> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not equal <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code>. </para> </li> <li> <para> <code>NOT_NULL</code> : The attribute exists. <code>NOT_NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the existence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NOT_NULL</code>, the result is a Boolean <i>true</i>. This result is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NOT_NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>NULL</code> : The attribute does not exist. <code>NULL</code> is supported for all datatypes, including lists and maps. </para> <note> <para> This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "<code>a</code>" is null, and you evaluate it using <code>NULL</code>, the result is a Boolean <i>false</i>. This is because the attribute "<code>a</code>" exists; its data type is not relevant to the <code>NULL</code> comparison operator. </para> </note> </li> <li> <para> <code>CONTAINS</code> : Checks for a subsequence, or value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it finds an exact match with any member of the set. </para> <para> CONTAINS is supported for lists: When evaluating "<code>a CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>NOT_CONTAINS</code> : Checks for absence of a subsequence, or absence of a value in a set. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("<code>SS</code>", "<code>NS</code>", or "<code>BS</code>"), then the operator evaluates to true if it <i>does not</i> find an exact match with any member of the set. </para> <para> NOT_CONTAINS is supported for lists: When evaluating "<code>a NOT CONTAINS b</code>", "<code>a</code>" can be a list; however, "<code>b</code>" cannot be a set, a map, or a list. </para> </li> <li> <para> <code>BEGINS_WITH</code> : Checks for a prefix. </para> <para> <i>AttributeValueList</i> can contain only one <i>AttributeValue</i> of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). </para> </li> <li> <para> <code>IN</code> : Checks for matching elements within two sets. </para> <para> <i>AttributeValueList</i> can contain one or more <i>AttributeValue</i> elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. </para> </li> <li> <para> <code>BETWEEN</code> : Greater than or equal to the first value, and less than or equal to the second value. </para> <para> <i>AttributeValueList</i> must contain two <i>AttributeValue</i> elements of the same type, either String, Number, or Binary (not a set type). 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> element of a different type than the one provided in the request, the value does not match. For example, <code>{"S":"6"}</code> does not compare to <code>{"N":"6"}</code>. Also, <code>{"N":"6"}</code> does not compare to <code>{"NS":["6", "2", "1"]}</code> </para> </li> </ul> </li> </ul> <para> For usage examples of <i>AttributeValueList</i> and <i>ComparisonOperator</i>, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy Conditional Parameters</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of <i>AttributeValueList</i> and <i>ComparisonOperator</i>: </para> <ul> <li> <para> <i>Value</i> - A value for DynamoDB to compare with an attribute. </para> </li> <li> <para> <i>Exists</i> - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation: </para> <ul> <li> <para> If <i>Exists</i> is <code>true</code>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the condition evaluates to true; otherwise the condition evaluate to false. </para> </li> <li> <para> If <i>Exists</i> is <code>false</code>, 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 condition evaluates to true. If the value is found, despite the assumption that it does not exist, the condition evaluates to false. </para> </li> </ul> <para> Note that the default value for <i>Exists</i> is <code>true</code>. </para> </li> </ul> <para> The <i>Value</i> and <i>Exists</i> parameters are incompatible with <i>AttributeValueList</i> and <i>ComparisonOperator</i>. Note that if you use both sets of parameters at once, DynamoDB will return a <i>ValidationException</i> exception. </para> <note> <para> This parameter does not support attributes of type List or Map. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ExpressionAttributeNames"> <summary> Gets and sets the property ExpressionAttributeNames. <para> One or more substitution tokens for attribute names in an expression. The following are some use cases for using <i>ExpressionAttributeNames</i>: </para> <ul> <li> <para> To access an attribute whose name conflicts with a DynamoDB reserved word. </para> </li> <li> <para> To create a placeholder for repeating occurrences of an attribute name in an expression. </para> </li> <li> <para> To prevent special characters in an attribute name from being misinterpreted in an expression. </para> </li> </ul> <para> Use the <b>#</b> character in an expression to dereference an attribute name. For example, consider the following attribute name: </para> <ul><li> <para> <code>Percentile</code> </para> </li></ul> <para> The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>). To work around this, you could specify the following for <i>ExpressionAttributeNames</i>: </para> <ul><li> <para> <code>{"#P":"Percentile"}</code> </para> </li></ul> <para> You could then use this substitution in an expression, as in this example: </para> <ul><li> <para> <code>#P = :val</code> </para> </li></ul> <note> <para> Tokens that begin with the <b>:</b> character are <i>expression attribute values</i>, which are placeholders for the actual value at runtime. </para> </note> <para> For more information on expression attribute names, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html">Accessing Item Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ExpressionAttributeValues"> <summary> Gets and sets the property ExpressionAttributeValues. <para> One or more values that can be substituted in an expression. </para> <para> Use the <b>:</b> (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the <i>ProductStatus</i> attribute was one of the following: </para> <para> <code>Available | Backordered | Discontinued</code> </para> <para> You would first need to specify <i>ExpressionAttributeValues</i> as follows: </para> <para> <code>{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }</code> </para> <para> You could then use these values in an expression, such as this: </para> <para> <code>ProductStatus IN (:avail, :back, :disc)</code> </para> <para> For more information on expression attribute values, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.Key"> <summary> Gets and sets the property Key. <para> The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. </para> <para> For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnConsumedCapacity"> <summary> Gets and sets the property ReturnConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnItemCollectionMetrics"> <summary> Gets and sets the property ReturnItemCollectionMetrics. <para> Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.ReturnValues"> <summary> Gets and sets the property ReturnValues. <para> 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: </para> <ul> <li> <para> <code>NONE</code> - If <i>ReturnValues</i> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <i>ReturnValues</i>.) </para> </li> <li> <para> <code>ALL_OLD</code> - If <i>UpdateItem</i> overwrote an attribute name-value pair, then the content of the old item is returned. </para> </li> <li> <para> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned. </para> </li> <li> <para> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned. </para> </li> <li> <para> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned. </para> </li> </ul> <para> There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed. </para> <para> Values returned are strongly consistent </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table containing the item to update. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemRequest.UpdateExpression"> <summary> Gets and sets the property UpdateExpression. <para> An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them. </para> <para> The following action values are available for <i>UpdateExpression</i>. </para> <ul> <li> <para> <code>SET</code> - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use <code>SET</code> to add or subtract from an attribute that is of type Number. For example: <code>SET myNum = myNum + :val</code> </para> <para> <code>SET</code> supports the following functions: </para> <ul> <li> <para> <code>if_not_exists (path, operand)</code> - if the item does not contain an attribute at the specified path, then <code>if_not_exists</code> evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item. </para> </li> <li> <para> <code>list_append (operand, operand)</code> - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands. </para> </li> </ul> <para> These function names are case-sensitive. </para> </li> <li> <para> <code>REMOVE</code> - Removes one or more attributes from an item. </para> </li> <li> <para> <code>ADD</code> - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of <code>ADD</code> depends on the data type of the attribute: </para> <ul> <li> <para> If the existing attribute is a number, and if <i>Value</i> is also a number, then <i>Value</i> is mathematically added to the existing attribute. If <i>Value</i> is a negative number, then it is subtracted from the existing attribute. </para> <note> <para> If you use <code>ADD</code> to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. </para> <para> Similarly, if you use <code>ADD</code> for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses <code>0</code> as the initial value. For example, suppose that the item you want to update doesn't have an attribute named <i>itemcount</i>, but you decide to <code>ADD</code> the number <code>3</code> to this attribute anyway. DynamoDB will create the <i>itemcount</i> attribute, set its initial value to <code>0</code>, and finally add <code>3</code> to it. The result will be a new <i>itemcount</i> attribute in the item, with a value of <code>3</code>. </para> </note> </li> <li> <para> If the existing data type is a set and if <i>Value</i> is also a set, then <i>Value</i> is added to the existing set. For example, if the attribute value is the set <code>[1,2]</code>, and the <code>ADD</code> action specified <code>[3]</code>, then the final attribute value is <code>[1,2,3]</code>. An error occurs if an <code>ADD</code> action is specified for a set attribute and the attribute type specified does not match the existing set type. </para> <para> 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. </para> </li> </ul> <important> <para> The <code>ADD</code> action only supports Number and set data types. In addition, <code>ADD</code> can only be used on top-level attributes, not nested attributes. </para> </important> </li> <li> <para> <code>DELETE</code> - Deletes an element from a set. </para> <para> If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set <code>[a,b,c]</code> and the <code>DELETE</code> action specifies <code>[a,c]</code>, then the final attribute value is <code>[b]</code>. Specifying an empty set is an error. </para> <important> <para> The <code>DELETE</code> action only supports set data types. In addition, <code>DELETE</code> can only be used on top-level attributes, not nested attributes. </para> </important> </li> </ul> <para> You can have many actions in a single expression, such as the following: <code>SET a=:value1, b=:value2 DELETE :value3, :value4, :value5</code> </para> <para> For more information on update expressions, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html">Modifying Items and Attributes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <note> <para> <i>UpdateExpression</i> replaces the legacy <i>AttributeUpdates</i> parameter. </para> </note> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemResponse"> <summary> Configuration for accessing Amazon UpdateItem service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateItemResult"> <summary> Represents the output of an <i>UpdateItem</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.Attributes"> <summary> Gets and sets the property Attributes. <para> A map of attribute values as they appeared before the <i>UpdateItem</i> operation. This map only appears if <i>ReturnValues</i> was specified as something other than <code>NONE</code> in the request. Each element represents one attribute. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.ConsumedCapacity"> <summary> Gets and sets the property ConsumedCapacity. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResult.ItemCollectionMetrics"> <summary> Gets and sets the property ItemCollectionMetrics. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateItemResponse.UpdateItemResult"> <summary> Gets and sets the UpdateItemResult property. Represents the output of a UpdateItem operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableRequest"> <summary> Container for the parameters to the UpdateTable operation. Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para> <ul> <li> <para> Modify the provisioned throughput settings of the table. </para> </li> <li> <para> Enable or disable Streams on the table. </para> </li> <li> <para> Remove a global secondary index from the table. </para> </li> <li> <para> Create a new global secondary index on the table. Once the index begins backfilling, you can use <i>UpdateTable</i> to perform other operations. </para> </li> </ul> <para> <i>UpdateTable</i> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <i>UpdateTable</i> request. When the table returns to the <code>ACTIVE</code> state, the <i>UpdateTable</i> operation is complete. </para> </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.UpdateTableRequest.#ctor(System.String,Amazon.DynamoDBv2.Model.ProvisionedThroughput)"> <summary> Instantiates UpdateTableRequest with the parameterized properties </summary> <param name="tableName">The name of the table to be updated.</param> <param name="provisionedThroughput">Sets the UpdateTableRequest ProvisionedThroughput property</param> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.AttributeDefinitions"> <summary> Gets and sets the property AttributeDefinitions. <para> An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, <i>AttributeDefinitions</i> must include the key element(s) of the new index. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.GlobalSecondaryIndexUpdates"> <summary> Gets and sets the property GlobalSecondaryIndexUpdates. <para> An array of one or more global secondary indexes for the table. For each index in the array, you can request one action: </para> <ul> <li> <para> <i>Create</i> - add a new global secondary index to the table. </para> </li> <li> <para> <i>Update</i> - modify the provisioned throughput settings of an existing global secondary index. </para> </li> <li> <para> <i>Delete</i> - remove a global secondary index from the table. </para> </li> </ul> <para> For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html">Managing Global Secondary Indexes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.ProvisionedThroughput"> <summary> Gets and sets the property ProvisionedThroughput. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.StreamSpecification"> <summary> Gets and sets the property StreamSpecification. <para> Represents the DynamoDB Streams configuration for the table. </para> <note> <para> You will receive a <i>ResourceInUseException</i> if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream. </para> </note> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableRequest.TableName"> <summary> Gets and sets the property TableName. <para> The name of the table to be updated. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableResponse"> <summary> Configuration for accessing Amazon UpdateTable service </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.UpdateTableResult"> <summary> Represents the output of an <i>UpdateTable</i> operation. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableResult.TableDescription"> <summary> Gets and sets the property TableDescription. </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.UpdateTableResponse.UpdateTableResult"> <summary> Gets and sets the UpdateTableResult property. Represents the output of a UpdateTable operation. </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.WriteRequest"> <summary> Represents an operation to perform - either <i>DeleteItem</i> or <i>PutItem</i>. You can only request 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 provide two separate <i>WriteRequest</i> objects. </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.WriteRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.DynamoDBv2.Model.WriteRequest.#ctor(Amazon.DynamoDBv2.Model.PutRequest)"> <summary> Instantiates WriteRequest with the parameterized properties </summary> <param name="putRequest">A request to perform a <i>PutItem</i> operation.</param> </member> <member name="M:Amazon.DynamoDBv2.Model.WriteRequest.#ctor(Amazon.DynamoDBv2.Model.DeleteRequest)"> <summary> Instantiates WriteRequest with the parameterized properties </summary> <param name="deleteRequest">A request to perform a <i>DeleteItem</i> operation.</param> </member> <member name="P:Amazon.DynamoDBv2.Model.WriteRequest.DeleteRequest"> <summary> Gets and sets the property DeleteRequest. <para> A request to perform a <i>DeleteItem</i> operation. </para> </summary> </member> <member name="P:Amazon.DynamoDBv2.Model.WriteRequest.PutRequest"> <summary> Gets and sets the property PutRequest. <para> A request to perform a <i>PutItem</i> operation. </para> </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeDefinitionMarshaller"> <summary> AttributeDefinition Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeDefinitionUnmarshaller"> <summary> Response Unmarshaller for AttributeDefinition Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeValueMarshaller"> <summary> AttributeValue Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeValueUnmarshaller"> <summary> Response Unmarshaller for AttributeValue Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.AttributeValueUpdateMarshaller"> <summary> AttributeValueUpdate Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.BatchGetItemRequestMarshaller"> <summary> BatchGetItem 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.BatchWriteItemRequestMarshaller"> <summary> BatchWriteItem 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.CapacityUnmarshaller"> <summary> Response Unmarshaller for Capacity Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ConditionMarshaller"> <summary> Condition Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ConsumedCapacityUnmarshaller"> <summary> Response Unmarshaller for ConsumedCapacity Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CreateGlobalSecondaryIndexActionMarshaller"> <summary> CreateGlobalSecondaryIndexAction Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.CreateTableRequestMarshaller"> <summary> CreateTable 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.DeleteGlobalSecondaryIndexActionMarshaller"> <summary> DeleteGlobalSecondaryIndexAction Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteItemRequestMarshaller"> <summary> DeleteItem 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.DeleteRequestMarshaller"> <summary> DeleteRequest Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteRequestUnmarshaller"> <summary> Response Unmarshaller for DeleteRequest Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DeleteTableRequestMarshaller"> <summary> DeleteTable 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.DescribeLimitsRequestMarshaller"> <summary> DescribeLimits Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeLimitsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeLimits operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeStreamRequestMarshaller"> <summary> DescribeStream Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeStreamResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeStream operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.DescribeTableRequestMarshaller"> <summary> DescribeTable 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.ExpectedAttributeValueMarshaller"> <summary> ExpectedAttributeValue Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetItemRequestMarshaller"> <summary> GetItem 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.GetRecordsRequestMarshaller"> <summary> GetRecords Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetRecordsResponseUnmarshaller"> <summary> Response Unmarshaller for GetRecords operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetShardIteratorRequestMarshaller"> <summary> GetShardIterator Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GetShardIteratorResponseUnmarshaller"> <summary> Response Unmarshaller for GetShardIterator operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GlobalSecondaryIndexDescriptionUnmarshaller"> <summary> Response Unmarshaller for GlobalSecondaryIndexDescription Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GlobalSecondaryIndexMarshaller"> <summary> GlobalSecondaryIndex Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.GlobalSecondaryIndexUpdateMarshaller"> <summary> GlobalSecondaryIndexUpdate Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ItemCollectionMetricsUnmarshaller"> <summary> Response Unmarshaller for ItemCollectionMetrics Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeysAndAttributesMarshaller"> <summary> KeysAndAttributes Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeysAndAttributesUnmarshaller"> <summary> Response Unmarshaller for KeysAndAttributes Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeySchemaElementMarshaller"> <summary> KeySchemaElement Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.KeySchemaElementUnmarshaller"> <summary> Response Unmarshaller for KeySchemaElement Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListStreamsRequestMarshaller"> <summary> ListStreams Request Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListStreamsResponseUnmarshaller"> <summary> Response Unmarshaller for ListStreams operation </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ListTablesRequestMarshaller"> <summary> ListTables 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.LocalSecondaryIndexDescriptionUnmarshaller"> <summary> Response Unmarshaller for LocalSecondaryIndexDescription Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.LocalSecondaryIndexMarshaller"> <summary> LocalSecondaryIndex Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProjectionMarshaller"> <summary> Projection Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProjectionUnmarshaller"> <summary> Response Unmarshaller for Projection Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProvisionedThroughputDescriptionUnmarshaller"> <summary> Response Unmarshaller for ProvisionedThroughputDescription Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ProvisionedThroughputMarshaller"> <summary> ProvisionedThroughput Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutItemRequestMarshaller"> <summary> PutItem 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.PutRequestMarshaller"> <summary> PutRequest Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.PutRequestUnmarshaller"> <summary> Response Unmarshaller for PutRequest Object </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.RecordUnmarshaller"> <summary> Response Unmarshaller for Record Object </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.SequenceNumberRangeUnmarshaller"> <summary> Response Unmarshaller for SequenceNumberRange Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.ShardUnmarshaller"> <summary> Response Unmarshaller for Shard Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.StreamDescriptionUnmarshaller"> <summary> Response Unmarshaller for StreamDescription Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.StreamRecordUnmarshaller"> <summary> Response Unmarshaller for StreamRecord Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.StreamSpecificationMarshaller"> <summary> StreamSpecification Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.StreamSpecificationUnmarshaller"> <summary> Response Unmarshaller for StreamSpecification Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.StreamSummaryUnmarshaller"> <summary> Response Unmarshaller for StreamSummary Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.TableDescriptionUnmarshaller"> <summary> Response Unmarshaller for TableDescription Object </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateGlobalSecondaryIndexActionMarshaller"> <summary> UpdateGlobalSecondaryIndexAction Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.UpdateItemRequestMarshaller"> <summary> UpdateItem 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.UpdateTableRequestMarshaller"> <summary> UpdateTable 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.WriteRequestMarshaller"> <summary> WriteRequest Marshaller </summary> </member> <member name="T:Amazon.DynamoDBv2.Model.Internal.MarshallTransformations.WriteRequestUnmarshaller"> <summary> Response Unmarshaller for WriteRequest Object </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.AsyncSearch`1"> <summary> A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB. </summary> <typeparam name="T"></typeparam> <summary> A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.BeginGetNextSet(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution to get the next set of results from DynamoDB. </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.DataModel.AsyncSearch`1.EndGetNextSet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BeginGetNextSet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetNextSet.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.BeginGetRemaining(System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution to get all the remaining results from DynamoDB. </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.DataModel.AsyncSearch`1.EndGetRemaining(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BeginGetRemaining operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetNextSet.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.AsyncSearch`1.IsDone"> <summary> Flag that, if true, indicates that the search is done </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.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 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 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 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> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> <summary> Represents a non-generic object for retrieving a batch of items from a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchGet.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="M:Amazon.DynamoDBv2.DataModel.BatchGet.Execute"> <summary> Executes a server call to batch-get the items requested. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.BatchGet.Results"> <summary> List of results retrieved from DynamoDB. Populated after Execute is called. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.BatchGet.ConsistentRead"> <summary> If set to true, a consistent read is issued. Otherwise eventually-consistent is used. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet"> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> <summary> Class for retrieving a batch of items from multiple DynamoDB tables, using multiple strongly-typed BatchGet objects </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchGet.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="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="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.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.BatchWrite"> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> <summary> Represents a non-generic object for writing/deleting a batch of items in a single DynamoDB table </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.BatchWrite.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="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="T:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite"> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> <summary> Class for writing/deleting a batch of items in multiple DynamoDB tables, using multiple strongly-typed BatchWrite objects </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.MultiTableBatchWrite.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="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="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.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="P:Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig.Conversion"> <summary> Conversion specification which controls how conversion between .NET and DynamoDB types happens. </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 or scan against. This value is optional if the index name can be inferred from the 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="P:Amazon.DynamoDBv2.DataModel.DynamoDBFlatConfig.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.DynamoDBFlatConfig.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.DynamoDBFlatConfig.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.DynamoDBFlatConfig.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="P:Amazon.DynamoDBv2.DataModel.DynamoDBFlatConfig.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.DynamoDBFlatConfig.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.DynamoDBFlatConfig.IndexName"> <summary> Property indicating the name of the index to query or scan against. This value is optional if the index name can be inferred from the call. </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.DynamoDBFlatConfig.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.DynamoDBFlatConfig.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="P:Amazon.DynamoDBv2.DataModel.DynamoDBFlatConfig.Conversion"> <summary> Conversion specification which controls how conversion between .NET and DynamoDB types happens. </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> <summary> Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context object for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.IDynamoDBContext"> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> <summary> Context interface for using the DataModel mode of DynamoDB. Used to interact with the service, save/load objects, etc. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.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.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.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.BeginExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[],System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecuteBatchGet operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"/> </summary> <param name="batches">Configured BatchGet objects</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteBatchGet operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.EndExecuteBatchGet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecuteBatchGet operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecuteBatchGet.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.BeginExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[],System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecuteBatchWrite operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"/> </summary> <param name="batches">Configured BatchWrite objects</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EndExecuteBatchWrite(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecuteBatchWrite operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecuteBatchWrite.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ScanAsync``1(Amazon.DynamoDBv2.DataModel.ScanCondition[])"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ScanAsync``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Object[])"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Between, values should be two values. </param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Between, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ToDocument``1(``0)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.ToDocument``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document})"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.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.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.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.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateBatchGet``1"> <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.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.IDynamoDBContext.CreateBatchWrite``1"> <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.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.Between, 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.Between, 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.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.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.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.BeginExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[],System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecuteBatchGet operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"/> </summary> <param name="batches">Configured BatchGet objects</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndExecuteBatchGet operation.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.EndExecuteBatchGet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecuteBatchGet operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecuteBatchGet.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.BeginExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[],System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ExecuteBatchWrite operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"/> </summary> <param name="batches">Configured BatchWrite objects</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EndExecuteBatchWrite(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ExecuteBatchWrite operation. <seealso cref="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"/> </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginExecuteBatchWrite.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ScanAsync``1(Amazon.DynamoDBv2.DataModel.ScanCondition[])"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ScanAsync``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromScanAsync``1(Amazon.DynamoDBv2.DocumentModel.ScanOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="scanConfig">Scan request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified hash primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Object[])"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Between, values should be two values. </param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.QueryAsync``1(System.Object,Amazon.DynamoDBv2.DocumentModel.QueryOperator,System.Collections.Generic.IEnumerable{System.Object},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified range element condition for a hash-and-range primary key. </summary> <typeparam name="T">Type of object.</typeparam> <param name="hashKeyValue">Hash key of the items to query.</param> <param name="op">Operation of the condition.</param> <param name="values"> Value(s) of the condition. For all operations except QueryOperator.Between, values should be one value. For QueryOperator.Between, values should be two values. </param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromQueryAsync``1(Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Configures an async Query operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="queryConfig">Query request object.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>AsyncSearch which can be used to retrieve DynamoDB data.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor"> <summary> Constructs a DynamoDBContext object with a default AmazonDynamoDBClient client and a default DynamoDBContextConfig object for configuration. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs a DynamoDBContext object with a default AmazonDynamoDBClient client and a default DynamoDBContextConfig object for configuration. </summary> <param name="region">The region to configure the AmazonDynamoDBClient to use.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified configuration. Uses a default AmazonDynamoDBClient as the client. </summary> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.RegionEndpoint,Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified configuration. Uses a default AmazonDynamoDBClient as the client. </summary> <param name="region">The region to configure the AmazonDynamoDBClient to use.</param> <param name="config"></param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.IAmazonDynamoDB)"> <summary> Constructs a DynamoDBContext object with the specified DynamoDB client. Uses default DynamoDBContextConfig object for configuration. </summary> <param name="client">Client to use for making calls</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.#ctor(Amazon.DynamoDBv2.IAmazonDynamoDB,Amazon.DynamoDBv2.DataModel.DynamoDBContextConfig)"> <summary> Constructs a DynamoDBContext object with the specified DynamoDB client and configuration. </summary> <param name="client">Client to use for making calls</param> <param name="config">Configuration to use</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern </summary> <param name="disposing">Whether this object is being disposed via a call to Dispose or garbage collected.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Finalize"> <summary> The destructor for the client class. </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchGet``1"> <summary> Creates a strongly-typed BatchGet object, allowing a batch-get operation against DynamoDB. </summary> <typeparam name="T">Type of objects to get</typeparam> <returns>Empty strongly-typed BatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchGet``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchGet object, allowing a batch-get operation against DynamoDB. </summary> <typeparam name="T">Type of objects to get</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateMultiTableBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Creates a MultiTableBatchGet object, composed of multiple individual BatchGet objects. </summary> <param name="batches">Individual BatchGet objects</param> <returns>Composite MultiTableBatchGet object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchWrite``1"> <summary> Creates a strongly-typed BatchWrite object, allowing a batch-write operation against DynamoDB. </summary> <typeparam name="T">Type of objects to write</typeparam> <returns>Empty strongly-typed BatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateBatchWrite``1(Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Creates a strongly-typed BatchWrite object, allowing a batch-write operation against DynamoDB. </summary> <typeparam name="T">Type of objects to write</typeparam> <param name="operationConfig">Config object which can be used to override that table used.</param> <returns>Empty strongly-typed BatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.CreateMultiTableBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Creates a MultiTableBatchWrite object, composed of multiple individual BatchWrite objects. </summary> <param name="batches">Individual BatchWrite objects</param> <returns>Composite MultiTableBatchWrite object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ToDocument``1(``0)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ToDocument``1(``0,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Serializes an object to a Document. </summary> <typeparam name="T">Type to serialize as.</typeparam> <param name="value">Object to serialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns>Document with attributes populated from object.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocument``1(Amazon.DynamoDBv2.DocumentModel.Document,Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a document to an instance of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="document">Document with properties to use.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Object of type T, populated with properties from the document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document})"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.FromDocuments``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DocumentModel.Document},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Deserializes a collections of documents to a collection of instances of type T. </summary> <typeparam name="T">Type to populate.</typeparam> <param name="documents">Documents to deserialize.</param> <param name="operationConfig">Config object which can be used to override the table used.</param> <returns> Collection of items of type T, each populated with properties from a corresponding document. </returns> </member> <member name="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.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.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.ExecuteBatchGet(Amazon.DynamoDBv2.DataModel.BatchGet[])"> <summary> Issues a batch-get request with multiple batches. Results are stored in the individual batches. </summary> <param name="batches"> Configured BatchGet objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ExecuteBatchWrite(Amazon.DynamoDBv2.DataModel.BatchWrite[])"> <summary> Issues a batch-write request with multiple batches. </summary> <param name="batches"> Configured BatchWrite objects </param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Scan``1(Amazon.DynamoDBv2.DataModel.ScanCondition[])"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <returns>Lazy-loaded collection of results.</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.DynamoDBContext.Scan``1(System.Collections.Generic.IEnumerable{Amazon.DynamoDBv2.DataModel.ScanCondition},Amazon.DynamoDBv2.DataModel.DynamoDBOperationConfig)"> <summary> Executes a Scan operation against DynamoDB, finding items that match the specified conditions. </summary> <typeparam name="T">Type of object.</typeparam> <param name="conditions"> Conditions that the results should meet. </param> <param name="operationConfig">Config object which can be used to override the 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.Between, 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.Between, 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="P:Amazon.DynamoDBv2.DataModel.DynamoDBContext.ConverterCache"> <summary> This cache is a way to store Converters for objects which provides a way to expand Context </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.SimplePropertyStorage"> <summary> Basic property storage information </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.PropertyStorage"> <summary> DynamoDB property storage information </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.PropertyStorage.Validate(Amazon.DynamoDBv2.DataModel.DynamoDBContext)"> <summary> Validates configurations and sets required fields </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.ItemStorage"> <summary> Storage information for a single item </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.GSIConfig"> <summary> GSI info </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.StorageConfig"> <summary> Storage information for a specific class </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.ItemStorageConfig"> <summary> Storage information for a specific class that is associated with a table </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.ItemStorageConfigCache"> <summary> Cache of ItemStorageConfig objects </summary> </member> <member name="T:Amazon.DynamoDBv2.DataModel.S3Link"> <summary> S3Link is an object that provides a connection to an S3 resource that can be stored in a DynamoDB field through DynamoDBContext </summary> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.BeginUploadFrom(System.String,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UploadFrom operation. </summary> <param name="sourcePath">Path of the file to be uploaded.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes</param> <param name="state">A 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.DynamoDBv2.DataModel.S3Link.EndUploadFrom(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UploadFrom operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUploadFrom.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.BeginDownloadTo(System.String,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DownloadTo operation. </summary> <param name="downloadPath">Path to save the file.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes</param> <param name="state">A 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.DynamoDBv2.DataModel.S3Link.EndDownloadTo(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DownloadTo operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDownloadTo.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.Create(Amazon.DynamoDBv2.DataModel.DynamoDBContext,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Creates an S3Link that can be used to managed an S3 connection </summary> <param name="context">The context that is handling the S3Link</param> <param name="bucket">The bucket the S3Link should manage</param> <param name="key">The key that S3Link should store and download from</param> <param name="region">The region of the S3 resource</param> <returns>A new S3Link object that can upload and download to the target bucket</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.MakeS3ObjectPublic(System.Boolean)"> <summary> If enable is set to true the object will have its permission set to PublicRead otherwise the permissions will be set to Private. </summary> <param name="enable">If true the object will have its permission set to PublicRead otherwise the permissions will be set to Private.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.SetACL(Amazon.S3.S3CannedACL)"> <summary> Sets the S3 Object's ACL </summary> <param name="cannedACL">CannedACL assigned to object</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.SetACL(Amazon.S3.Model.S3AccessControlList)"> <summary> Sets the S3 Objects's ACL </summary> <param name="acl">ACL assigned to the S3 object</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.GetPreSignedURL(System.DateTime)"> <summary> Provides a URL for accessing the S3 object managed by S3Link </summary> <param name="expiration">The time the link should become invalid</param> <returns>A URL directing to the S3 object</returns> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.UploadFrom(System.String)"> <summary> Uploads the specified file and stores it in the specified bucket with the provided key from construction. </summary> <param name="sourcePath">Path of the file to be uploaded.</param> </member> <member name="M:Amazon.DynamoDBv2.DataModel.S3Link.DownloadTo(System.String)"> <summary> Downloads the file from the S3Link's specified bucket and key then saves it in the given path. Creates directories and the file if they do not already exist. </summary> <param name="downloadPath">Path to save the file.</param> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.Key"> <summary> The Key that S3Link stores and downloads a resource to and from </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.BucketName"> <summary> The name of the target Bucket for the managed resource </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.Region"> <summary> The region the S3 resource is in </summary> </member> <member name="P:Amazon.DynamoDBv2.DataModel.S3Link.RegionAsEndpoint"> <summary> Looks up RegionEndpoint based on region as a string </summary> </member> <member name="T:Amazon.EC2.AmazonEC2Client"> <summary> Implementation for accessing EC2 Amazon Elastic Compute Cloud <para> Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster. </para> </summary> <summary> Implementation for accessing AmazonEC2. <para> Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides resizable compute capacity in the cloud. It is designed to make web-scale computing easier for developers. </para> <para> Amazon EC2's simple web service interface allows you to obtain and configure capacity with minimal friction. It provides you with complete control of your computing resources and lets you run on Amazon's proven computing environment. Amazon EC2 reduces the time required to obtain and boot new server instances to minutes, allowing you to quickly scale capacity, both up and down, as your computing requirements change. Amazon EC2 changes the economics of computing by allowing you to pay only for capacity that you actually use. Amazon EC2 provides developers the tools to build failure resilient applications and isolate themselves from common failure scenarios. </para> <para> Visit http://aws.amazon.com/ec2/ for more information. </para> </summary> </member> <member name="T:Amazon.EC2.IAmazonEC2"> <summary> Interface for accessing EC2 Amazon Elastic Compute Cloud <para> Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster. </para> </summary> </member> <member name="M:Amazon.EC2.IAmazonEC2.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.</param> <returns>The response from the AcceptVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcceptVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAcceptVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcceptVpcPeeringConnection.</param> <returns>Returns a AcceptVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AllocateAddress"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress service method.</param> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAllocateAddress(Amazon.EC2.Model.AllocateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocateAddress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAllocateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateAddress.</param> <returns>Returns a AllocateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses service method.</param> <returns>The response from the AssignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssignPrivateIpAddresses operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAssignPrivateIpAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssignPrivateIpAddresses.</param> <returns>Returns a AssignPrivateIpAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para> <para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress service method.</param> <returns>The response from the AssociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAssociateAddress(Amazon.EC2.Model.AssociateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateAddress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAssociateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateAddress.</param> <returns>Returns a AssociateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions service method.</param> <returns>The response from the AssociateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAssociateDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateDhcpOptions.</param> <returns>Returns a AssociateDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable service method.</param> <returns>The response from the AssociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAssociateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateRouteTable.</param> <returns>Returns a AssociateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest)"> <summary> Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para> <para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc service method.</param> <returns>The response from the AttachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachClassicLinkVpc operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAttachClassicLinkVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachClassicLinkVpc.</param> <returns>Returns a AttachClassicLinkVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway service method.</param> <returns>The response from the AttachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAttachInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachInternetGateway.</param> <returns>Returns a AttachInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> <summary> Attaches a network interface to an instance. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface service method.</param> <returns>The response from the AttachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAttachNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachNetworkInterface.</param> <returns>Returns a AttachNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If a volume has an AWS Marketplace product code: </para> <ul> <li>The volume can be attached only to a stopped instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> <li>You must be subscribed to the product.</li> <li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li> </ul> <para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para> <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume service method.</param> <returns>The response from the AttachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAttachVolume(Amazon.EC2.Model.AttachVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachVolume operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAttachVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachVolume.</param> <returns>Returns a AttachVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway service method.</param> <returns>The response from the AttachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAttachVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachVpnGateway.</param> <returns>Returns a AttachVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important> <para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para> </important> <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para> <para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.</param> <returns>The response from the AuthorizeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeSecurityGroupEgress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAuthorizeSecurityGroupEgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeSecurityGroupEgress.</param> <returns>Returns a AuthorizeSecurityGroupEgressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. <important> <para> EC2-Classic: You can have up to 100 rules per group. </para> <para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para> </important> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> <para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para> <para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginAuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndAuthorizeSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeSecurityGroupIngress.</param> <returns>Returns a AuthorizeSecurityGroupIngressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para> <note> <para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance service method.</param> <returns>The response from the BundleInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginBundleInstance(Amazon.EC2.Model.BundleInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BundleInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBundleInstance operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndBundleInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BundleInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBundleInstance.</param> <returns>Returns a BundleInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask service method.</param> <returns>The response from the CancelBundleTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelBundleTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelBundleTask operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelBundleTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelBundleTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelBundleTask.</param> <returns>Returns a CancelBundleTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask service method.</param> <returns>The response from the CancelConversionTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelConversionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelConversionTask operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelConversionTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelConversionTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelConversionTask.</param> <returns>Returns a CancelConversionTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelExportTask operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelExportTask.</param> <returns>Returns a CancelExportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest)"> <summary> Cancels an in-process import virtual machine or import snapshot task. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask service method.</param> <returns>The response from the CancelImportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelImportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelImportTask operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelImportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelImportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelImportTask.</param> <returns>Returns a CancelImportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing service method.</param> <returns>The response from the CancelReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelReservedInstancesListing operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelReservedInstancesListing(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelReservedInstancesListing.</param> <returns>Returns a CancelReservedInstancesListingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest)"> <summary> Cancels the specified Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests service method.</param> <returns>The response from the CancelSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelSpotFleetRequests operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelSpotFleetRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelSpotFleetRequests.</param> <returns>Returns a CancelSpotFleetRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important> <para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests service method.</param> <returns>The response from the CancelSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelSpotInstanceRequests operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCancelSpotInstanceRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelSpotInstanceRequests.</param> <returns>Returns a CancelSpotInstanceRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance service method.</param> <returns>The response from the ConfirmProductInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmProductInstance operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndConfirmProductInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmProductInstance.</param> <returns>Returns a ConfirmProductInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyImage service method.</param> <returns>The response from the CopyImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCopyImage(Amazon.EC2.Model.CopyImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopyImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyImage operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCopyImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopyImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopyImage.</param> <returns>Returns a CopyImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCopySnapshot(Amazon.EC2.Model.CopySnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndCopySnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopySnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopySnapshot.</param> <returns>Returns a CopySnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para> <note> <para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para> </note> <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway service method.</param> <returns>The response from the CreateCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCustomerGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateCustomerGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCustomerGateway.</param> <returns>Returns a CreateCustomerGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul> <li> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li> <li> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li> <li> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li> </ul> <para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions service method.</param> <returns>The response from the CreateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDhcpOptions.</param> <returns>Returns a CreateDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest)"> <summary> Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs service method.</param> <returns>The response from the CreateFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateFlowLogs.</param> <returns>Returns a CreateFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateImage service method.</param> <returns>The response from the CreateImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateImage(Amazon.EC2.Model.CreateImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateImage operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateImage.</param> <returns>Returns a CreateImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask service method.</param> <returns>The response from the CreateInstanceExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInstanceExportTask operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateInstanceExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInstanceExportTask.</param> <returns>Returns a CreateInstanceExportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInternetGateway"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway service method.</param> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInternetGateway.</param> <returns>Returns a CreateInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para> <para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para> <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair service method.</param> <returns>The response from the CreateKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateKeyPair.</param> <returns>Returns a CreateKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl service method.</param> <returns>The response from the CreateNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkAcl operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateNetworkAcl(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkAcl.</param> <returns>Returns a CreateNetworkAclResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para> <para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para> <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry service method.</param> <returns>The response from the CreateNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkAclEntry.</param> <returns>Returns a CreateNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface service method.</param> <returns>The response from the CreateNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkInterface.</param> <returns>Returns a CreateNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup service method.</param> <returns>The response from the CreatePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePlacementGroup operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreatePlacementGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePlacementGroup.</param> <returns>Returns a CreatePlacementGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing service method.</param> <returns>The response from the CreateReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateReservedInstancesListing operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateReservedInstancesListing(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateReservedInstancesListing.</param> <returns>Returns a CreateReservedInstancesListingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para> <para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para> <ul> <li> <para> <code>192.0.2.0/24</code> (goes to some target A) </para> </li> <li> <para> <code>192.0.2.0/28</code> (goes to some target B) </para> </li> </ul> <para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute service method.</param> <returns>The response from the CreateRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateRoute(Amazon.EC2.Model.CreateRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRoute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRoute.</param> <returns>Returns a CreateRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable service method.</param> <returns>The response from the CreateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRouteTable.</param> <returns>Returns a CreateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> EC2-Classic: You can have up to 500 security groups. </para> <para> EC2-VPC: You can create up to 100 security groups per VPC. </para> </important> <para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para> <para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para> <para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup service method.</param> <returns>The response from the CreateSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSecurityGroup operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSecurityGroup.</param> <returns>Returns a CreateSecurityGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para> <para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para> <para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para> <para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a CreateSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method.</param> <returns>The response from the CreateSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSpotDatafeedSubscription.</param> <returns>Returns a CreateSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para> <important> <para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para> </important> <para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para> <para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para> <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet service method.</param> <returns>The response from the CreateSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateSubnet(Amazon.EC2.Model.CreateSubnetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSubnet operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateSubnet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSubnet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSubnet.</param> <returns>Returns a CreateSubnetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateTags(Amazon.EC2.Model.CreateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTags operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTags.</param> <returns>Returns a CreateTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para> <para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume service method.</param> <returns>The response from the CreateVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVolume(Amazon.EC2.Model.CreateVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVolume operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVolume.</param> <returns>Returns a CreateVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc service method.</param> <returns>The response from the CreateVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpc(Amazon.EC2.Model.CreateVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpc operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpc.</param> <returns>Returns a CreateVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest)"> <summary> Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint service method.</param> <returns>The response from the CreateVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpcEndpoint operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpcEndpoint(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpcEndpoint.</param> <returns>Returns a CreateVpcEndpointResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para> <para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection service method.</param> <returns>The response from the CreateVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpcPeeringConnection.</param> <returns>Returns a CreateVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest)"> <summary> Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para> <important> <para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para> </important> <para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para> <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection service method.</param> <returns>The response from the CreateVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpnConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnConnection.</param> <returns>Returns a CreateVpnConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute service method.</param> <returns>The response from the CreateVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnConnectionRoute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpnConnectionRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnConnectionRoute.</param> <returns>Returns a CreateVpnConnectionRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway service method.</param> <returns>The response from the CreateVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginCreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndCreateVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnGateway.</param> <returns>Returns a CreateVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway service method.</param> <returns>The response from the DeleteCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCustomerGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteCustomerGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCustomerGateway.</param> <returns>Returns a DeleteCustomerGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions service method.</param> <returns>The response from the DeleteDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDhcpOptions.</param> <returns>Returns a DeleteDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest)"> <summary> Deletes one or more flow logs. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs service method.</param> <returns>The response from the DeleteFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteFlowLogs.</param> <returns>Returns a DeleteFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway service method.</param> <returns>The response from the DeleteInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInternetGateway.</param> <returns>Returns a DeleteInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair service method.</param> <returns>The response from the DeleteKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteKeyPair.</param> <returns>Returns a DeleteKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl service method.</param> <returns>The response from the DeleteNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkAcl operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteNetworkAcl(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkAcl.</param> <returns>Returns a DeleteNetworkAclResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry service method.</param> <returns>The response from the DeleteNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkAclEntry.</param> <returns>Returns a DeleteNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface service method.</param> <returns>The response from the DeleteNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkInterface.</param> <returns>Returns a DeleteNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup service method.</param> <returns>The response from the DeletePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePlacementGroup operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeletePlacementGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePlacementGroup.</param> <returns>Returns a DeletePlacementGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes the specified route from the specified route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute service method.</param> <returns>The response from the DeleteRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteRoute(Amazon.EC2.Model.DeleteRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRoute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRoute.</param> <returns>Returns a DeleteRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable service method.</param> <returns>The response from the DeleteRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRouteTable.</param> <returns>Returns a DeleteRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup service method.</param> <returns>The response from the DeleteSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSecurityGroup operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSecurityGroup.</param> <returns>Returns a DeleteSecurityGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para> <para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a DeleteSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSpotDatafeedSubscription"> <summary> Deletes the data feed for Spot instances. </summary> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the data feed for Spot instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method.</param> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSpotDatafeedSubscription.</param> <returns>Returns a DeleteSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet service method.</param> <returns>The response from the DeleteSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSubnet operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteSubnet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSubnet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSubnet.</param> <returns>Returns a DeleteSubnetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteTags(Amazon.EC2.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndDeleteTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTags.</param> <returns>Returns a DeleteTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note> <para> The volume may remain in the <code>deleting</code> state for several minutes. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVolume operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVolume.</param> <returns>Returns a DeleteVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc service method.</param> <returns>The response from the DeleteVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpc(Amazon.EC2.Model.DeleteVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpc operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpc.</param> <returns>Returns a DeleteVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest)"> <summary> Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints service method.</param> <returns>The response from the DeleteVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpcEndpoints operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpcEndpoints(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpcEndpoints.</param> <returns>Returns a DeleteVpcEndpointsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method.</param> <returns>The response from the DeleteVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpcPeeringConnection.</param> <returns>Returns a DeleteVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection service method.</param> <returns>The response from the DeleteVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpnConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnConnection.</param> <returns>Returns a DeleteVpnConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute service method.</param> <returns>The response from the DeleteVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnConnectionRoute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpnConnectionRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnConnectionRoute.</param> <returns>Returns a DeleteVpnConnectionRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway service method.</param> <returns>The response from the DeleteVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeleteVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnGateway.</param> <returns>Returns a DeleteVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage service method.</param> <returns>The response from the DeregisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDeregisterImage(Amazon.EC2.Model.DeregisterImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterImage operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDeregisterImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterImage.</param> <returns>Returns a DeregisterImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAccountAttributes"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAccountAttributes operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeAccountAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountAttributes.</param> <returns>Returns a DescribeAccountAttributesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAddresses"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses service method.</param> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAddresses operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAddresses.</param> <returns>Returns a DescribeAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAvailabilityZones"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones service method.</param> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAvailabilityZones operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeAvailabilityZones(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityZones.</param> <returns>Returns a DescribeAvailabilityZonesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeBundleTasks"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks service method.</param> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeBundleTasks operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeBundleTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeBundleTasks.</param> <returns>Returns a DescribeBundleTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest)"> <summary> Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances service method.</param> <returns>The response from the DescribeClassicLinkInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeClassicLinkInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeClassicLinkInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeClassicLinkInstances.</param> <returns>Returns a DescribeClassicLinkInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeConversionTasks"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks service method.</param> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConversionTasks operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeConversionTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConversionTasks.</param> <returns>Returns a DescribeConversionTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeCustomerGateways"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways service method.</param> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCustomerGateways operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeCustomerGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCustomerGateways.</param> <returns>Returns a DescribeCustomerGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeDhcpOptions"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions service method.</param> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDhcpOptions.</param> <returns>Returns a DescribeDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeExportTasks"> <summary> Describes one or more of your export tasks. </summary> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes one or more of your export tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExportTasks operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeExportTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExportTasks.</param> <returns>Returns a DescribeExportTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest)"> <summary> Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs service method.</param> <returns>The response from the DescribeFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeFlowLogs.</param> <returns>Returns a DescribeFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute service method.</param> <returns>The response from the DescribeImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImageAttribute.</param> <returns>Returns a DescribeImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImages"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages service method.</param> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeImages(Amazon.EC2.Model.DescribeImagesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImages operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImages operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeImages(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImages operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImages.</param> <returns>Returns a DescribeImagesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest)"> <summary> Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks service method.</param> <returns>The response from the DescribeImportImageTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImportImageTasks operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeImportImageTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImportImageTasks.</param> <returns>Returns a DescribeImportImageTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest)"> <summary> Describes your import snapshot tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks service method.</param> <returns>The response from the DescribeImportSnapshotTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImportSnapshotTasks operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeImportSnapshotTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImportSnapshotTasks.</param> <returns>Returns a DescribeImportSnapshotTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute service method.</param> <returns>The response from the DescribeInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceAttribute.</param> <returns>Returns a DescribeInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstances"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstances.</param> <returns>Returns a DescribeInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceStatus"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus service method.</param> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceStatus operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeInstanceStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceStatus.</param> <returns>Returns a DescribeInstanceStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInternetGateways"> <summary> Describes one or more of your Internet gateways. </summary> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Describes one or more of your Internet gateways. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways service method.</param> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInternetGateways operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeInternetGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInternetGateways.</param> <returns>Returns a DescribeInternetGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeKeyPairs"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs service method.</param> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeKeyPairs operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeKeyPairs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeKeyPairs.</param> <returns>Returns a DescribeKeyPairsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest)"> <summary> Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses service method.</param> <returns>The response from the DescribeMovingAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMovingAddresses operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeMovingAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMovingAddresses.</param> <returns>Returns a DescribeMovingAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkAcls"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls service method.</param> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkAcls operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeNetworkAcls(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkAcls.</param> <returns>Returns a DescribeNetworkAclsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute service method.</param> <returns>The response from the DescribeNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkInterfaceAttribute.</param> <returns>Returns a DescribeNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaces"> <summary> Describes one or more of your network interfaces. </summary> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more of your network interfaces. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces service method.</param> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkInterfaces operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeNetworkInterfaces(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkInterfaces.</param> <returns>Returns a DescribeNetworkInterfacesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePlacementGroups"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups service method.</param> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePlacementGroups operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribePlacementGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePlacementGroups.</param> <returns>Returns a DescribePlacementGroupsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest)"> <summary> Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists service method.</param> <returns>The response from the DescribePrefixLists service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePrefixLists operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribePrefixLists(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePrefixLists.</param> <returns>Returns a DescribePrefixListsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRegions"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions service method.</param> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRegions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRegions operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeRegions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRegions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRegions.</param> <returns>Returns a DescribeRegionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstances"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances service method.</param> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeReservedInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstances.</param> <returns>Returns a DescribeReservedInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesListings"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings service method.</param> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesListings operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeReservedInstancesListings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesListings.</param> <returns>Returns a DescribeReservedInstancesListingsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesModifications"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications service method.</param> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesModifications operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeReservedInstancesModifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesModifications.</param> <returns>Returns a DescribeReservedInstancesModificationsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesOfferings"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method.</param> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesOfferings operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeReservedInstancesOfferings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesOfferings.</param> <returns>Returns a DescribeReservedInstancesOfferingsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRouteTables"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables service method.</param> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRouteTables operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeRouteTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRouteTables.</param> <returns>Returns a DescribeRouteTablesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSecurityGroups"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups service method.</param> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSecurityGroups operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSecurityGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSecurityGroups.</param> <returns>Returns a DescribeSecurityGroupsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute service method.</param> <returns>The response from the DescribeSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshotAttribute.</param> <returns>Returns a DescribeSnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshots"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotDatafeedSubscription"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method.</param> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotDatafeedSubscription.</param> <returns>Returns a DescribeSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest)"> <summary> Describes the running instances for the specified Spot fleet. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances service method.</param> <returns>The response from the DescribeSpotFleetInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotFleetInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetInstances.</param> <returns>Returns a DescribeSpotFleetInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest)"> <summary> Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory service method.</param> <returns>The response from the DescribeSpotFleetRequestHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetRequestHistory operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotFleetRequestHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetRequestHistory.</param> <returns>Returns a DescribeSpotFleetRequestHistoryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest)"> <summary> Describes your Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests service method.</param> <returns>The response from the DescribeSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetRequests operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotFleetRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetRequests.</param> <returns>Returns a DescribeSpotFleetRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotInstanceRequests"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method.</param> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotInstanceRequests operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotInstanceRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotInstanceRequests.</param> <returns>Returns a DescribeSpotInstanceRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotPriceHistory"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory service method.</param> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotPriceHistory operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSpotPriceHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotPriceHistory.</param> <returns>Returns a DescribeSpotPriceHistoryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSubnets"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets service method.</param> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSubnets operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSubnets operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSubnets.</param> <returns>Returns a DescribeSubnetsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeTags"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeTags(Amazon.EC2.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.IAmazonEC2.EndDescribeTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTags.</param> <returns>Returns a DescribeTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute service method.</param> <returns>The response from the DescribeVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumeAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVolumeAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumeAttribute.</param> <returns>Returns a DescribeVolumeAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumes"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumes operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVolumes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumes.</param> <returns>Returns a DescribeVolumesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeStatus"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus service method.</param> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumeStatus operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVolumeStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumeStatus.</param> <returns>Returns a DescribeVolumeStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute service method.</param> <returns>The response from the DescribeVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcAttribute.</param> <returns>Returns a DescribeVpcAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest)"> <summary> Describes the ClassicLink status of one or more VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink service method.</param> <returns>The response from the DescribeVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcClassicLink.</param> <returns>Returns a DescribeVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest)"> <summary> Describes one or more of your VPC endpoints. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints service method.</param> <returns>The response from the DescribeVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcEndpoints operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcEndpoints(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcEndpoints.</param> <returns>Returns a DescribeVpcEndpointsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest)"> <summary> Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices service method.</param> <returns>The response from the DescribeVpcEndpointServices service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcEndpointServices operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcEndpointServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcEndpointServices.</param> <returns>Returns a DescribeVpcEndpointServicesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcPeeringConnections"> <summary> Describes one or more of your VPC peering connections. </summary> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> Describes one or more of your VPC peering connections. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method.</param> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcPeeringConnections operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcPeeringConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcPeeringConnections.</param> <returns>Returns a DescribeVpcPeeringConnectionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcs"> <summary> Describes one or more of your VPCs. </summary> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Describes one or more of your VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs service method.</param> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcs operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpcs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcs.</param> <returns>Returns a DescribeVpcsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnConnections"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections service method.</param> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpnConnections operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpnConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpnConnections.</param> <returns>Returns a DescribeVpnConnectionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnGateways"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways service method.</param> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpnGateways operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDescribeVpnGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpnGateways.</param> <returns>Returns a DescribeVpnGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest)"> <summary> Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc service method.</param> <returns>The response from the DetachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachClassicLinkVpc operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDetachClassicLinkVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachClassicLinkVpc.</param> <returns>Returns a DetachClassicLinkVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway service method.</param> <returns>The response from the DetachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDetachInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachInternetGateway.</param> <returns>Returns a DetachInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> <summary> Detaches a network interface from an instance. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface service method.</param> <returns>The response from the DetachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDetachNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachNetworkInterface.</param> <returns>Returns a DetachNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para> <para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume service method.</param> <returns>The response from the DetachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDetachVolume(Amazon.EC2.Model.DetachVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachVolume operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDetachVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachVolume.</param> <returns>Returns a DetachVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway service method.</param> <returns>The response from the DetachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDetachVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachVpnGateway.</param> <returns>Returns a DetachVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation service method.</param> <returns>The response from the DisableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableVgwRoutePropagation operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDisableVgwRoutePropagation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableVgwRoutePropagation.</param> <returns>Returns a DisableVgwRoutePropagationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest)"> <summary> Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink service method.</param> <returns>The response from the DisableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDisableVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableVpcClassicLink.</param> <returns>Returns a DisableVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress service method.</param> <returns>The response from the DisassociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisassociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateAddress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDisassociateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisassociateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisassociateAddress.</param> <returns>Returns a DisassociateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable service method.</param> <returns>The response from the DisassociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginDisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndDisassociateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisassociateRouteTable.</param> <returns>Returns a DisassociateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest)"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation service method.</param> <returns>The response from the EnableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginEnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVgwRoutePropagation operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndEnableVgwRoutePropagation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVgwRoutePropagation.</param> <returns>Returns a EnableVgwRoutePropagationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest)"> <summary> Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO service method.</param> <returns>The response from the EnableVolumeIO service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginEnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVolumeIO operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndEnableVolumeIO(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVolumeIO.</param> <returns>Returns a EnableVolumeIOResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest)"> <summary> Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink service method.</param> <returns>The response from the EnableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginEnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndEnableVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVpcClassicLink.</param> <returns>Returns a EnableVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para> <para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para> <para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para> <para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput service method.</param> <returns>The response from the GetConsoleOutput service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginGetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetConsoleOutput operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndGetConsoleOutput(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetConsoleOutput.</param> <returns>Returns a GetConsoleOutputResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for an instance running Windows. <para> The Windows password is generated at boot if the <code>EC2Config</code> service plugin, <code>Ec2SetPassword</code>, is enabled. This usually only happens the first time an AMI is launched, and then <code>Ec2SetPassword</code> is automatically disabled. The password is not generated for rebundled AMIs unless <code>Ec2SetPassword</code> is enabled before bundling. </para> <para> The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. </para> <para> Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData service method.</param> <returns>The response from the GetPasswordData service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginGetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPasswordData operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPasswordData operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndGetPasswordData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPasswordData operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPasswordData.</param> <returns>Returns a GetPasswordDataResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportImage(Amazon.EC2.Model.ImportImageRequest)"> <summary> Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> <param name="request">Container for the necessary parameters to execute the ImportImage service method.</param> <returns>The response from the ImportImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginImportImage(Amazon.EC2.Model.ImportImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportImage operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportImage operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndImportImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportImage.</param> <returns>Returns a ImportImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> Creates an import instance task using metadata from the specified disk image. <code>ImportInstance</code> only supports single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a>. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the EC2 command line tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance service method.</param> <returns>The response from the ImportInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginImportInstance(Amazon.EC2.Model.ImportInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportInstance operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndImportInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportInstance.</param> <returns>Returns a ImportInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair service method.</param> <returns>The response from the ImportKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndImportKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportKeyPair.</param> <returns>Returns a ImportKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest)"> <summary> Imports a disk into an EBS snapshot. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot service method.</param> <returns>The response from the ImportSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportSnapshot operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndImportSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportSnapshot.</param> <returns>Returns a ImportSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the Amazon EC2 command-line interface (CLI) tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume service method.</param> <returns>The response from the ImportVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginImportVolume(Amazon.EC2.Model.ImportVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportVolume operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndImportVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportVolume.</param> <returns>Returns a ImportVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note> <para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute service method.</param> <returns>The response from the ModifyImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyImageAttribute.</param> <returns>Returns a ModifyImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute service method.</param> <returns>The response from the ModifyInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyInstanceAttribute.</param> <returns>Returns a ModifyInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute service method.</param> <returns>The response from the ModifyNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyNetworkInterfaceAttribute.</param> <returns>Returns a ModifyNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest)"> <summary> Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances service method.</param> <returns>The response from the ModifyReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyReservedInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyReservedInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyReservedInstances.</param> <returns>Returns a ModifyReservedInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> <para> Snapshots with AWS Marketplace product codes cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute service method.</param> <returns>The response from the ModifySnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifySnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifySnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifySnapshotAttribute.</param> <returns>Returns a ModifySnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest)"> <summary> Modifies a subnet attribute. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute service method.</param> <returns>The response from the ModifySubnetAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifySubnetAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifySubnetAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifySubnetAttribute.</param> <returns>Returns a ModifySubnetAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para> <para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute service method.</param> <returns>The response from the ModifyVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVolumeAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyVolumeAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVolumeAttribute.</param> <returns>Returns a ModifyVolumeAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modifies the specified attribute of the specified VPC. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute service method.</param> <returns>The response from the ModifyVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVpcAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyVpcAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVpcAttribute.</param> <returns>Returns a ModifyVpcAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest)"> <summary> Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint service method.</param> <returns>The response from the ModifyVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVpcEndpoint operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndModifyVpcEndpoint(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVpcEndpoint.</param> <returns>Returns a ModifyVpcEndpointResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances service method.</param> <returns>The response from the MonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginMonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMonitorInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndMonitorInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MonitorInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMonitorInstances.</param> <returns>Returns a MonitorInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.MoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest)"> <summary> Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc service method.</param> <returns>The response from the MoveAddressToVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginMoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMoveAddressToVpc operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndMoveAddressToVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMoveAddressToVpc.</param> <returns>Returns a MoveAddressToVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method.</param> <returns>The response from the PurchaseReservedInstancesOffering service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginPurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPurchaseReservedInstancesOffering operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndPurchaseReservedInstancesOffering(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPurchaseReservedInstancesOffering.</param> <returns>Returns a PurchaseReservedInstancesOfferingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances service method.</param> <returns>The response from the RebootInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRebootInstances(Amazon.EC2.Model.RebootInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebootInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebootInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRebootInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebootInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebootInstances.</param> <returns>Returns a RebootInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note> <para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> </note> <para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <important> <para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para> <para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para> <para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para> </important> <para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para> <note> <para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage service method.</param> <returns>The response from the RegisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRegisterImage(Amazon.EC2.Model.RegisterImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterImage operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRegisterImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterImage.</param> <returns>Returns a RegisterImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection service method.</param> <returns>The response from the RejectVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRejectVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRejectVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRejectVpcPeeringConnection.</param> <returns>Returns a RejectVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para> <para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para> <para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress service method.</param> <returns>The response from the ReleaseAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReleaseAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReleaseAddress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReleaseAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReleaseAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReleaseAddress.</param> <returns>Returns a ReleaseAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation service method.</param> <returns>The response from the ReplaceNetworkAclAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceNetworkAclAssociation operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReplaceNetworkAclAssociation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceNetworkAclAssociation.</param> <returns>Returns a ReplaceNetworkAclAssociationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry service method.</param> <returns>The response from the ReplaceNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReplaceNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceNetworkAclEntry.</param> <returns>Returns a ReplaceNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> <summary> Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute service method.</param> <returns>The response from the ReplaceRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceRoute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReplaceRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceRoute.</param> <returns>Returns a ReplaceRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> <summary> Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation service method.</param> <returns>The response from the ReplaceRouteTableAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceRouteTableAssociation operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReplaceRouteTableAssociation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceRouteTableAssociation.</param> <returns>Returns a ReplaceRouteTableAssociationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus service method.</param> <returns>The response from the ReportInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportInstanceStatus operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndReportInstanceStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportInstanceStatus.</param> <returns>Returns a ReportInstanceStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest)"> <summary> Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para> <para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para> <para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet service method.</param> <returns>The response from the RequestSpotFleet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestSpotFleet operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRequestSpotFleet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestSpotFleet.</param> <returns>Returns a RequestSpotFleetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances service method.</param> <returns>The response from the RequestSpotInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestSpotInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRequestSpotInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestSpotInstances.</param> <returns>Returns a RequestSpotInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> <summary> Resets an attribute of an AMI to its default value. <note> <para> The productCodes attribute can't be reset. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute service method.</param> <returns>The response from the ResetImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndResetImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetImageAttribute.</param> <returns>Returns a ResetImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute service method.</param> <returns>The response from the ResetInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndResetInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetInstanceAttribute.</param> <returns>Returns a ResetInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Resets a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute service method.</param> <returns>The response from the ResetNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndResetNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetNetworkInterfaceAttribute.</param> <returns>Returns a ResetNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute service method.</param> <returns>The response from the ResetSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetSnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndResetSnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetSnapshotAttribute.</param> <returns>Returns a ResetSnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest)"> <summary> Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic service method.</param> <returns>The response from the RestoreAddressToClassic service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreAddressToClassic operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRestoreAddressToClassic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreAddressToClassic.</param> <returns>Returns a RestoreAddressToClassicResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress service method.</param> <returns>The response from the RevokeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeSecurityGroupEgress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRevokeSecurityGroupEgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeSecurityGroupEgress.</param> <returns>Returns a RevokeSecurityGroupEgressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress service method.</param> <returns>The response from the RevokeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRevokeSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeSecurityGroupIngress.</param> <returns>Returns a RevokeSecurityGroupIngressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> Launches the specified number of instances using an AMI for which you have permissions. <para> When you launch an instance, it enters the <code>pending</code> state. After the instance is ready for you, it enters the <code>running</code> state. To check the state of your instance, call <a>DescribeInstances</a>. </para> <para> If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you. </para> <para> [EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you. </para> <para> Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> You can provide optional user data when launching an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If any of the AMIs have a product code attached for which the user has not subscribed, <code>RunInstances</code> fails. </para> <para> T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, <code>RunInstances</code> fails. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What To Do If An Instance Immediately Terminates</a>, and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunInstances service method.</param> <returns>The response from the RunInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginRunInstances(Amazon.EC2.Model.RunInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RunInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndRunInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunInstances.</param> <returns>Returns a RunInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StartInstances(Amazon.EC2.Model.StartInstancesRequest)"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstances service method.</param> <returns>The response from the StartInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginStartInstances(Amazon.EC2.Model.StartInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndStartInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartInstances.</param> <returns>Returns a StartInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. <para> You can't start or stop Spot Instances. </para> <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshooting Stopping Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstances service method.</param> <returns>The response from the StopInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginStopInstances(Amazon.EC2.Model.StopInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndStopInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopInstances.</param> <returns>Returns a StopInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. <para> Terminated instances remain visible after termination (for approximately one hour). </para> <para> By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances service method.</param> <returns>The response from the TerminateInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginTerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndTerminateInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateInstances.</param> <returns>Returns a TerminateInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> <summary> Unassigns one or more secondary private IP addresses from a network interface. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses service method.</param> <returns>The response from the UnassignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginUnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnassignPrivateIpAddresses operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndUnassignPrivateIpAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnassignPrivateIpAddresses.</param> <returns>Returns a UnassignPrivateIpAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances service method.</param> <returns>The response from the UnmonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.BeginUnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnmonitorInstances operation.</returns> </member> <member name="M:Amazon.EC2.IAmazonEC2.EndUnmonitorInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnmonitorInstances.</param> <returns>Returns a UnmonitorInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonEC2Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(Amazon.Runtime.AWSCredentials,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Credentials and an AmazonEC2Client Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.#ctor(System.String,System.String,System.String,Amazon.EC2.AmazonEC2Config)"> <summary> Constructs AmazonEC2Client with AWS Access Key ID, AWS Secret Key and an AmazonEC2Client Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonEC2Client Configuration Object</param> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest)"> <summary> Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.</param> <returns>The response from the AcceptVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAcceptVpcPeeringConnection(Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the AcceptVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAcceptVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAcceptVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AcceptVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAcceptVpcPeeringConnection.</param> <returns>Returns a AcceptVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddress"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AllocateAddress(Amazon.EC2.Model.AllocateAddressRequest)"> <summary> Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress service method.</param> <returns>The response from the AllocateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAllocateAddress(Amazon.EC2.Model.AllocateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AllocateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AllocateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAllocateAddress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAllocateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AllocateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAllocateAddress.</param> <returns>Returns a AllocateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest)"> <summary> Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses service method.</param> <returns>The response from the AssignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAssignPrivateIpAddresses(Amazon.EC2.Model.AssignPrivateIpAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the AssignPrivateIpAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssignPrivateIpAddresses operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAssignPrivateIpAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssignPrivateIpAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssignPrivateIpAddresses.</param> <returns>Returns a AssignPrivateIpAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateAddress(Amazon.EC2.Model.AssociateAddressRequest)"> <summary> Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para> <para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress service method.</param> <returns>The response from the AssociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAssociateAddress(Amazon.EC2.Model.AssociateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateAddress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAssociateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateAddress.</param> <returns>Returns a AssociateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest)"> <summary> Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions service method.</param> <returns>The response from the AssociateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAssociateDhcpOptions(Amazon.EC2.Model.AssociateDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAssociateDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateDhcpOptions.</param> <returns>Returns a AssociateDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest)"> <summary> Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable service method.</param> <returns>The response from the AssociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAssociateRouteTable(Amazon.EC2.Model.AssociateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the AssociateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAssociateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAssociateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AssociateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAssociateRouteTable.</param> <returns>Returns a AssociateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest)"> <summary> Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para> <para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc service method.</param> <returns>The response from the AttachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAttachClassicLinkVpc(Amazon.EC2.Model.AttachClassicLinkVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachClassicLinkVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachClassicLinkVpc operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAttachClassicLinkVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachClassicLinkVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachClassicLinkVpc.</param> <returns>Returns a AttachClassicLinkVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest)"> <summary> Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway service method.</param> <returns>The response from the AttachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAttachInternetGateway(Amazon.EC2.Model.AttachInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAttachInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachInternetGateway.</param> <returns>Returns a AttachInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest)"> <summary> Attaches a network interface to an instance. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface service method.</param> <returns>The response from the AttachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAttachNetworkInterface(Amazon.EC2.Model.AttachNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAttachNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachNetworkInterface.</param> <returns>Returns a AttachNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVolume(Amazon.EC2.Model.AttachVolumeRequest)"> <summary> Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If a volume has an AWS Marketplace product code: </para> <ul> <li>The volume can be attached only to a stopped instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> <li>You must be subscribed to the product.</li> <li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li> </ul> <para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para> <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume service method.</param> <returns>The response from the AttachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAttachVolume(Amazon.EC2.Model.AttachVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachVolume operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAttachVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachVolume.</param> <returns>Returns a AttachVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest)"> <summary> Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway service method.</param> <returns>The response from the AttachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAttachVpnGateway(Amazon.EC2.Model.AttachVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the AttachVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAttachVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAttachVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AttachVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAttachVpnGateway.</param> <returns>Returns a AttachVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest)"> <summary> Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important> <para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para> </important> <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para> <para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.</param> <returns>The response from the AuthorizeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAuthorizeSecurityGroupEgress(Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupEgress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeSecurityGroupEgress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAuthorizeSecurityGroupEgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeSecurityGroupEgress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeSecurityGroupEgress.</param> <returns>Returns a AuthorizeSecurityGroupEgressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.AuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest)"> <summary> Adds one or more ingress rules to a security group. <important> <para> EC2-Classic: You can have up to 100 rules per group. </para> <para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para> </important> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> <para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para> <para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.</param> <returns>The response from the AuthorizeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginAuthorizeSecurityGroupIngress(Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the AuthorizeSecurityGroupIngress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndAuthorizeSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndAuthorizeSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the AuthorizeSecurityGroupIngress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginAuthorizeSecurityGroupIngress.</param> <returns>Returns a AuthorizeSecurityGroupIngressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BundleInstance(Amazon.EC2.Model.BundleInstanceRequest)"> <summary> Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para> <note> <para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance service method.</param> <returns>The response from the BundleInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginBundleInstance(Amazon.EC2.Model.BundleInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the BundleInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the BundleInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndBundleInstance operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndBundleInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the BundleInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginBundleInstance.</param> <returns>Returns a BundleInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest)"> <summary> Cancels a bundling operation for an instance store-backed Windows instance. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask service method.</param> <returns>The response from the CancelBundleTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelBundleTask(Amazon.EC2.Model.CancelBundleTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelBundleTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelBundleTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelBundleTask operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelBundleTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelBundleTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelBundleTask.</param> <returns>Returns a CancelBundleTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest)"> <summary> Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask service method.</param> <returns>The response from the CancelConversionTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelConversionTask(Amazon.EC2.Model.CancelConversionTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelConversionTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelConversionTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelConversionTask operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelConversionTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelConversionTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelConversionTask.</param> <returns>Returns a CancelConversionTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest)"> <summary> Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask service method.</param> <returns>The response from the CancelExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelExportTask(Amazon.EC2.Model.CancelExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelExportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelExportTask operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelExportTask.</param> <returns>Returns a CancelExportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest)"> <summary> Cancels an in-process import virtual machine or import snapshot task. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask service method.</param> <returns>The response from the CancelImportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelImportTask(Amazon.EC2.Model.CancelImportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelImportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelImportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelImportTask operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelImportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelImportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelImportTask.</param> <returns>Returns a CancelImportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest)"> <summary> Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing service method.</param> <returns>The response from the CancelReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelReservedInstancesListing(Amazon.EC2.Model.CancelReservedInstancesListingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelReservedInstancesListing operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelReservedInstancesListing operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelReservedInstancesListing(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelReservedInstancesListing operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelReservedInstancesListing.</param> <returns>Returns a CancelReservedInstancesListingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest)"> <summary> Cancels the specified Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests service method.</param> <returns>The response from the CancelSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelSpotFleetRequests(Amazon.EC2.Model.CancelSpotFleetRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotFleetRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelSpotFleetRequests operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelSpotFleetRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelSpotFleetRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelSpotFleetRequests.</param> <returns>Returns a CancelSpotFleetRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest)"> <summary> Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important> <para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests service method.</param> <returns>The response from the CancelSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCancelSpotInstanceRequests(Amazon.EC2.Model.CancelSpotInstanceRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the CancelSpotInstanceRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelSpotInstanceRequests operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCancelSpotInstanceRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CancelSpotInstanceRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCancelSpotInstanceRequests.</param> <returns>Returns a CancelSpotInstanceRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest)"> <summary> Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance service method.</param> <returns>The response from the ConfirmProductInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginConfirmProductInstance(Amazon.EC2.Model.ConfirmProductInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ConfirmProductInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndConfirmProductInstance operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndConfirmProductInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ConfirmProductInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginConfirmProductInstance.</param> <returns>Returns a ConfirmProductInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopyImage(Amazon.EC2.Model.CopyImageRequest)"> <summary> Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopyImage service method.</param> <returns>The response from the CopyImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCopyImage(Amazon.EC2.Model.CopyImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopyImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CopyImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCopyImage operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCopyImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopyImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopyImage.</param> <returns>Returns a CopyImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CopySnapshot(Amazon.EC2.Model.CopySnapshotRequest)"> <summary> Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot service method.</param> <returns>The response from the CopySnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCopySnapshot(Amazon.EC2.Model.CopySnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CopySnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CopySnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndCopySnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CopySnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCopySnapshot.</param> <returns>Returns a CopySnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest)"> <summary> Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para> <note> <para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para> </note> <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway service method.</param> <returns>The response from the CreateCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateCustomerGateway(Amazon.EC2.Model.CreateCustomerGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCustomerGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCustomerGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateCustomerGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCustomerGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCustomerGateway.</param> <returns>Returns a CreateCustomerGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest)"> <summary> Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul> <li> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li> <li> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li> <li> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li> </ul> <para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions service method.</param> <returns>The response from the CreateDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateDhcpOptions(Amazon.EC2.Model.CreateDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateDhcpOptions.</param> <returns>Returns a CreateDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest)"> <summary> Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs service method.</param> <returns>The response from the CreateFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateFlowLogs(Amazon.EC2.Model.CreateFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateFlowLogs.</param> <returns>Returns a CreateFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateImage(Amazon.EC2.Model.CreateImageRequest)"> <summary> Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateImage service method.</param> <returns>The response from the CreateImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateImage(Amazon.EC2.Model.CreateImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateImage operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateImage operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateImage.</param> <returns>Returns a CreateImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest)"> <summary> Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask service method.</param> <returns>The response from the CreateInstanceExportTask service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateInstanceExportTask(Amazon.EC2.Model.CreateInstanceExportTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInstanceExportTask operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInstanceExportTask operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateInstanceExportTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInstanceExportTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInstanceExportTask.</param> <returns>Returns a CreateInstanceExportTaskResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGateway"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest)"> <summary> Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway service method.</param> <returns>The response from the CreateInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateInternetGateway(Amazon.EC2.Model.CreateInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateInternetGateway.</param> <returns>Returns a CreateInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest)"> <summary> Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para> <para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para> <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair service method.</param> <returns>The response from the CreateKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateKeyPair(Amazon.EC2.Model.CreateKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateKeyPair.</param> <returns>Returns a CreateKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest)"> <summary> Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl service method.</param> <returns>The response from the CreateNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateNetworkAcl(Amazon.EC2.Model.CreateNetworkAclRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAcl operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkAcl operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateNetworkAcl(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkAcl operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkAcl.</param> <returns>Returns a CreateNetworkAclResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest)"> <summary> Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para> <para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para> <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry service method.</param> <returns>The response from the CreateNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateNetworkAclEntry(Amazon.EC2.Model.CreateNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkAclEntry.</param> <returns>Returns a CreateNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest)"> <summary> Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface service method.</param> <returns>The response from the CreateNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateNetworkInterface(Amazon.EC2.Model.CreateNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateNetworkInterface.</param> <returns>Returns a CreateNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest)"> <summary> Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup service method.</param> <returns>The response from the CreatePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreatePlacementGroup(Amazon.EC2.Model.CreatePlacementGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreatePlacementGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreatePlacementGroup operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreatePlacementGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreatePlacementGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreatePlacementGroup.</param> <returns>Returns a CreatePlacementGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest)"> <summary> Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing service method.</param> <returns>The response from the CreateReservedInstancesListing service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateReservedInstancesListing(Amazon.EC2.Model.CreateReservedInstancesListingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateReservedInstancesListing operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateReservedInstancesListing operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateReservedInstancesListing(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateReservedInstancesListing operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateReservedInstancesListing.</param> <returns>Returns a CreateReservedInstancesListingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRoute(Amazon.EC2.Model.CreateRouteRequest)"> <summary> Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para> <para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para> <ul> <li> <para> <code>192.0.2.0/24</code> (goes to some target A) </para> </li> <li> <para> <code>192.0.2.0/28</code> (goes to some target B) </para> </li> </ul> <para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute service method.</param> <returns>The response from the CreateRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateRoute(Amazon.EC2.Model.CreateRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRoute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRoute.</param> <returns>Returns a CreateRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest)"> <summary> Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable service method.</param> <returns>The response from the CreateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateRouteTable(Amazon.EC2.Model.CreateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateRouteTable.</param> <returns>Returns a CreateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest)"> <summary> Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> EC2-Classic: You can have up to 500 security groups. </para> <para> EC2-VPC: You can create up to 100 security groups per VPC. </para> </important> <para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para> <para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para> <para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup service method.</param> <returns>The response from the CreateSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateSecurityGroup(Amazon.EC2.Model.CreateSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSecurityGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSecurityGroup operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSecurityGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSecurityGroup.</param> <returns>Returns a CreateSecurityGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest)"> <summary> Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para> <para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para> <para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para> <para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot service method.</param> <returns>The response from the CreateSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateSnapshot(Amazon.EC2.Model.CreateSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndCreateSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSnapshot.</param> <returns>Returns a CreateSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest)"> <summary> Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription service method.</param> <returns>The response from the CreateSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateSpotDatafeedSubscription(Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSpotDatafeedSubscription.</param> <returns>Returns a CreateSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateSubnet(Amazon.EC2.Model.CreateSubnetRequest)"> <summary> Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para> <important> <para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para> </important> <para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para> <para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para> <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet service method.</param> <returns>The response from the CreateSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateSubnet(Amazon.EC2.Model.CreateSubnetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateSubnet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateSubnet operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateSubnet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateSubnet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateSubnet.</param> <returns>Returns a CreateSubnetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateTags(Amazon.EC2.Model.CreateTagsRequest)"> <summary> Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateTags service method.</param> <returns>The response from the CreateTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateTags(Amazon.EC2.Model.CreateTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateTags operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateTags operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateTags.</param> <returns>Returns a CreateTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVolume(Amazon.EC2.Model.CreateVolumeRequest)"> <summary> Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para> <para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume service method.</param> <returns>The response from the CreateVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVolume(Amazon.EC2.Model.CreateVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVolume operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVolume.</param> <returns>Returns a CreateVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpc(Amazon.EC2.Model.CreateVpcRequest)"> <summary> Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc service method.</param> <returns>The response from the CreateVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpc(Amazon.EC2.Model.CreateVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpc operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpc.</param> <returns>Returns a CreateVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest)"> <summary> Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint service method.</param> <returns>The response from the CreateVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpcEndpoint(Amazon.EC2.Model.CreateVpcEndpointRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcEndpoint operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpcEndpoint operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpcEndpoint(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpcEndpoint operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpcEndpoint.</param> <returns>Returns a CreateVpcEndpointResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest)"> <summary> Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para> <para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection service method.</param> <returns>The response from the CreateVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpcPeeringConnection(Amazon.EC2.Model.CreateVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpcPeeringConnection.</param> <returns>Returns a CreateVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest)"> <summary> Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para> <important> <para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para> </important> <para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para> <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection service method.</param> <returns>The response from the CreateVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpnConnection(Amazon.EC2.Model.CreateVpnConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpnConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnConnection.</param> <returns>Returns a CreateVpnConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest)"> <summary> Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute service method.</param> <returns>The response from the CreateVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpnConnectionRoute(Amazon.EC2.Model.CreateVpnConnectionRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnConnectionRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnConnectionRoute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpnConnectionRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnConnectionRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnConnectionRoute.</param> <returns>Returns a CreateVpnConnectionRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.CreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest)"> <summary> Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway service method.</param> <returns>The response from the CreateVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginCreateVpnGateway(Amazon.EC2.Model.CreateVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndCreateVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateVpnGateway.</param> <returns>Returns a CreateVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest)"> <summary> Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway service method.</param> <returns>The response from the DeleteCustomerGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteCustomerGateway(Amazon.EC2.Model.DeleteCustomerGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCustomerGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCustomerGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteCustomerGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCustomerGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCustomerGateway.</param> <returns>Returns a DeleteCustomerGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest)"> <summary> Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions service method.</param> <returns>The response from the DeleteDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteDhcpOptions(Amazon.EC2.Model.DeleteDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteDhcpOptions.</param> <returns>Returns a DeleteDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest)"> <summary> Deletes one or more flow logs. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs service method.</param> <returns>The response from the DeleteFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteFlowLogs(Amazon.EC2.Model.DeleteFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteFlowLogs.</param> <returns>Returns a DeleteFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest)"> <summary> Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway service method.</param> <returns>The response from the DeleteInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteInternetGateway(Amazon.EC2.Model.DeleteInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteInternetGateway.</param> <returns>Returns a DeleteInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest)"> <summary> Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair service method.</param> <returns>The response from the DeleteKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteKeyPair(Amazon.EC2.Model.DeleteKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteKeyPair.</param> <returns>Returns a DeleteKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest)"> <summary> Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl service method.</param> <returns>The response from the DeleteNetworkAcl service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteNetworkAcl(Amazon.EC2.Model.DeleteNetworkAclRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAcl operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkAcl operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteNetworkAcl(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkAcl operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkAcl.</param> <returns>Returns a DeleteNetworkAclResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest)"> <summary> Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry service method.</param> <returns>The response from the DeleteNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteNetworkAclEntry(Amazon.EC2.Model.DeleteNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkAclEntry.</param> <returns>Returns a DeleteNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest)"> <summary> Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface service method.</param> <returns>The response from the DeleteNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteNetworkInterface(Amazon.EC2.Model.DeleteNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteNetworkInterface.</param> <returns>Returns a DeleteNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest)"> <summary> Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup service method.</param> <returns>The response from the DeletePlacementGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeletePlacementGroup(Amazon.EC2.Model.DeletePlacementGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeletePlacementGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeletePlacementGroup operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeletePlacementGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeletePlacementGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeletePlacementGroup.</param> <returns>Returns a DeletePlacementGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRoute(Amazon.EC2.Model.DeleteRouteRequest)"> <summary> Deletes the specified route from the specified route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute service method.</param> <returns>The response from the DeleteRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteRoute(Amazon.EC2.Model.DeleteRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRoute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRoute.</param> <returns>Returns a DeleteRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest)"> <summary> Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable service method.</param> <returns>The response from the DeleteRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteRouteTable(Amazon.EC2.Model.DeleteRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteRouteTable.</param> <returns>Returns a DeleteRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest)"> <summary> Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup service method.</param> <returns>The response from the DeleteSecurityGroup service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteSecurityGroup(Amazon.EC2.Model.DeleteSecurityGroupRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSecurityGroup operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSecurityGroup operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteSecurityGroup(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSecurityGroup operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSecurityGroup.</param> <returns>Returns a DeleteSecurityGroupResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest)"> <summary> Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para> <para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot service method.</param> <returns>The response from the DeleteSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteSnapshot(Amazon.EC2.Model.DeleteSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndDeleteSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSnapshot.</param> <returns>Returns a DeleteSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscription"> <summary> Deletes the data feed for Spot instances. </summary> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest)"> <summary> Deletes the data feed for Spot instances. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription service method.</param> <returns>The response from the DeleteSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteSpotDatafeedSubscription(Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSpotDatafeedSubscription.</param> <returns>Returns a DeleteSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest)"> <summary> Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet service method.</param> <returns>The response from the DeleteSubnet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteSubnet(Amazon.EC2.Model.DeleteSubnetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteSubnet operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteSubnet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteSubnet operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteSubnet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteSubnet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteSubnet.</param> <returns>Returns a DeleteSubnetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteTags(Amazon.EC2.Model.DeleteTagsRequest)"> <summary> Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags service method.</param> <returns>The response from the DeleteTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteTags(Amazon.EC2.Model.DeleteTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndDeleteTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteTags.</param> <returns>Returns a DeleteTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest)"> <summary> Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note> <para> The volume may remain in the <code>deleting</code> state for several minutes. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume service method.</param> <returns>The response from the DeleteVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVolume(Amazon.EC2.Model.DeleteVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVolume operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVolume.</param> <returns>Returns a DeleteVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpc(Amazon.EC2.Model.DeleteVpcRequest)"> <summary> Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc service method.</param> <returns>The response from the DeleteVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpc(Amazon.EC2.Model.DeleteVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpc operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpc.</param> <returns>Returns a DeleteVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest)"> <summary> Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints service method.</param> <returns>The response from the DeleteVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpcEndpoints(Amazon.EC2.Model.DeleteVpcEndpointsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcEndpoints operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpcEndpoints operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpcEndpoints(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpcEndpoints operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpcEndpoints.</param> <returns>Returns a DeleteVpcEndpointsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest)"> <summary> Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection service method.</param> <returns>The response from the DeleteVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpcPeeringConnection(Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpcPeeringConnection.</param> <returns>Returns a DeleteVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest)"> <summary> Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection service method.</param> <returns>The response from the DeleteVpnConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpnConnection(Amazon.EC2.Model.DeleteVpnConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpnConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnConnection.</param> <returns>Returns a DeleteVpnConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest)"> <summary> Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute service method.</param> <returns>The response from the DeleteVpnConnectionRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpnConnectionRoute(Amazon.EC2.Model.DeleteVpnConnectionRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnConnectionRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnConnectionRoute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpnConnectionRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnConnectionRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnConnectionRoute.</param> <returns>Returns a DeleteVpnConnectionRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest)"> <summary> Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway service method.</param> <returns>The response from the DeleteVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeleteVpnGateway(Amazon.EC2.Model.DeleteVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeleteVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteVpnGateway.</param> <returns>Returns a DeleteVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DeregisterImage(Amazon.EC2.Model.DeregisterImageRequest)"> <summary> Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage service method.</param> <returns>The response from the DeregisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDeregisterImage(Amazon.EC2.Model.DeregisterImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterImage operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDeregisterImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterImage.</param> <returns>Returns a DeregisterImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributes"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest)"> <summary> Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes service method.</param> <returns>The response from the DescribeAccountAttributes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeAccountAttributes(Amazon.EC2.Model.DescribeAccountAttributesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAccountAttributes operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAccountAttributes operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeAccountAttributes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAccountAttributes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAccountAttributes.</param> <returns>Returns a DescribeAccountAttributesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddresses"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest)"> <summary> Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses service method.</param> <returns>The response from the DescribeAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeAddresses(Amazon.EC2.Model.DescribeAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAddresses operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAddresses.</param> <returns>Returns a DescribeAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZones"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest)"> <summary> Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones service method.</param> <returns>The response from the DescribeAvailabilityZones service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeAvailabilityZones(Amazon.EC2.Model.DescribeAvailabilityZonesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeAvailabilityZones operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeAvailabilityZones operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeAvailabilityZones(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeAvailabilityZones operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeAvailabilityZones.</param> <returns>Returns a DescribeAvailabilityZonesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasks"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest)"> <summary> Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks service method.</param> <returns>The response from the DescribeBundleTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeBundleTasks(Amazon.EC2.Model.DescribeBundleTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeBundleTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeBundleTasks operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeBundleTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeBundleTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeBundleTasks.</param> <returns>Returns a DescribeBundleTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest)"> <summary> Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances service method.</param> <returns>The response from the DescribeClassicLinkInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeClassicLinkInstances(Amazon.EC2.Model.DescribeClassicLinkInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClassicLinkInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeClassicLinkInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeClassicLinkInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeClassicLinkInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeClassicLinkInstances.</param> <returns>Returns a DescribeClassicLinkInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasks"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest)"> <summary> Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks service method.</param> <returns>The response from the DescribeConversionTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeConversionTasks(Amazon.EC2.Model.DescribeConversionTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeConversionTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConversionTasks operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeConversionTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeConversionTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeConversionTasks.</param> <returns>Returns a DescribeConversionTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGateways"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest)"> <summary> Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways service method.</param> <returns>The response from the DescribeCustomerGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeCustomerGateways(Amazon.EC2.Model.DescribeCustomerGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeCustomerGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeCustomerGateways operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeCustomerGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeCustomerGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeCustomerGateways.</param> <returns>Returns a DescribeCustomerGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptions"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest)"> <summary> Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions service method.</param> <returns>The response from the DescribeDhcpOptions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeDhcpOptions(Amazon.EC2.Model.DescribeDhcpOptionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeDhcpOptions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDhcpOptions operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeDhcpOptions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeDhcpOptions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeDhcpOptions.</param> <returns>Returns a DescribeDhcpOptionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasks"> <summary> Describes one or more of your export tasks. </summary> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest)"> <summary> Describes one or more of your export tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks service method.</param> <returns>The response from the DescribeExportTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeExportTasks(Amazon.EC2.Model.DescribeExportTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeExportTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExportTasks operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeExportTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeExportTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeExportTasks.</param> <returns>Returns a DescribeExportTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest)"> <summary> Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs service method.</param> <returns>The response from the DescribeFlowLogs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeFlowLogs(Amazon.EC2.Model.DescribeFlowLogsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeFlowLogs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlowLogs operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeFlowLogs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeFlowLogs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeFlowLogs.</param> <returns>Returns a DescribeFlowLogsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest)"> <summary> Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute service method.</param> <returns>The response from the DescribeImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeImageAttribute(Amazon.EC2.Model.DescribeImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImageAttribute.</param> <returns>Returns a DescribeImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImages"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImages(Amazon.EC2.Model.DescribeImagesRequest)"> <summary> Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages service method.</param> <returns>The response from the DescribeImages service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeImages(Amazon.EC2.Model.DescribeImagesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImages operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImages operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImages operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeImages(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImages operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImages.</param> <returns>Returns a DescribeImagesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest)"> <summary> Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks service method.</param> <returns>The response from the DescribeImportImageTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeImportImageTasks(Amazon.EC2.Model.DescribeImportImageTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportImageTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImportImageTasks operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeImportImageTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImportImageTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImportImageTasks.</param> <returns>Returns a DescribeImportImageTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest)"> <summary> Describes your import snapshot tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks service method.</param> <returns>The response from the DescribeImportSnapshotTasks service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeImportSnapshotTasks(Amazon.EC2.Model.DescribeImportSnapshotTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeImportSnapshotTasks operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeImportSnapshotTasks operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeImportSnapshotTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeImportSnapshotTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeImportSnapshotTasks.</param> <returns>Returns a DescribeImportSnapshotTasksResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest)"> <summary> Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute service method.</param> <returns>The response from the DescribeInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeInstanceAttribute(Amazon.EC2.Model.DescribeInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceAttribute.</param> <returns>Returns a DescribeInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstances"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest)"> <summary> Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances service method.</param> <returns>The response from the DescribeInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeInstances(Amazon.EC2.Model.DescribeInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstances.</param> <returns>Returns a DescribeInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatus"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest)"> <summary> Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus service method.</param> <returns>The response from the DescribeInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeInstanceStatus(Amazon.EC2.Model.DescribeInstanceStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInstanceStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInstanceStatus operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeInstanceStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInstanceStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInstanceStatus.</param> <returns>Returns a DescribeInstanceStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGateways"> <summary> Describes one or more of your Internet gateways. </summary> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest)"> <summary> Describes one or more of your Internet gateways. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways service method.</param> <returns>The response from the DescribeInternetGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeInternetGateways(Amazon.EC2.Model.DescribeInternetGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeInternetGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeInternetGateways operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeInternetGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeInternetGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeInternetGateways.</param> <returns>Returns a DescribeInternetGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairs"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest)"> <summary> Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs service method.</param> <returns>The response from the DescribeKeyPairs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeKeyPairs(Amazon.EC2.Model.DescribeKeyPairsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeKeyPairs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeKeyPairs operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeKeyPairs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeKeyPairs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeKeyPairs.</param> <returns>Returns a DescribeKeyPairsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest)"> <summary> Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses service method.</param> <returns>The response from the DescribeMovingAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeMovingAddresses(Amazon.EC2.Model.DescribeMovingAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeMovingAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMovingAddresses operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeMovingAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeMovingAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeMovingAddresses.</param> <returns>Returns a DescribeMovingAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAcls"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest)"> <summary> Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls service method.</param> <returns>The response from the DescribeNetworkAcls service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeNetworkAcls(Amazon.EC2.Model.DescribeNetworkAclsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkAcls operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkAcls operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeNetworkAcls(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkAcls operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkAcls.</param> <returns>Returns a DescribeNetworkAclsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest)"> <summary> Describes a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute service method.</param> <returns>The response from the DescribeNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeNetworkInterfaceAttribute(Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkInterfaceAttribute.</param> <returns>Returns a DescribeNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaces"> <summary> Describes one or more of your network interfaces. </summary> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest)"> <summary> Describes one or more of your network interfaces. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces service method.</param> <returns>The response from the DescribeNetworkInterfaces service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeNetworkInterfaces(Amazon.EC2.Model.DescribeNetworkInterfacesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeNetworkInterfaces operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeNetworkInterfaces operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeNetworkInterfaces(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeNetworkInterfaces operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeNetworkInterfaces.</param> <returns>Returns a DescribeNetworkInterfacesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroups"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest)"> <summary> Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups service method.</param> <returns>The response from the DescribePlacementGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribePlacementGroups(Amazon.EC2.Model.DescribePlacementGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePlacementGroups operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePlacementGroups operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribePlacementGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePlacementGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePlacementGroups.</param> <returns>Returns a DescribePlacementGroupsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest)"> <summary> Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists service method.</param> <returns>The response from the DescribePrefixLists service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribePrefixLists(Amazon.EC2.Model.DescribePrefixListsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribePrefixLists operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribePrefixLists operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribePrefixLists(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribePrefixLists operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribePrefixLists.</param> <returns>Returns a DescribePrefixListsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegions"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest)"> <summary> Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions service method.</param> <returns>The response from the DescribeRegions service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeRegions(Amazon.EC2.Model.DescribeRegionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRegions operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRegions operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRegions operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeRegions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRegions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRegions.</param> <returns>Returns a DescribeRegionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstances"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest)"> <summary> Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances service method.</param> <returns>The response from the DescribeReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeReservedInstances(Amazon.EC2.Model.DescribeReservedInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeReservedInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstances.</param> <returns>Returns a DescribeReservedInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesListings"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest)"> <summary> Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings service method.</param> <returns>The response from the DescribeReservedInstancesListings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeReservedInstancesListings(Amazon.EC2.Model.DescribeReservedInstancesListingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesListings operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesListings operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeReservedInstancesListings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesListings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesListings.</param> <returns>Returns a DescribeReservedInstancesListingsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModifications"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest)"> <summary> Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications service method.</param> <returns>The response from the DescribeReservedInstancesModifications service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeReservedInstancesModifications(Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesModifications operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesModifications operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeReservedInstancesModifications(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesModifications operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesModifications.</param> <returns>Returns a DescribeReservedInstancesModificationsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferings"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest)"> <summary> Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings service method.</param> <returns>The response from the DescribeReservedInstancesOfferings service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeReservedInstancesOfferings(Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeReservedInstancesOfferings operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeReservedInstancesOfferings operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeReservedInstancesOfferings(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeReservedInstancesOfferings operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeReservedInstancesOfferings.</param> <returns>Returns a DescribeReservedInstancesOfferingsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTables"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest)"> <summary> Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables service method.</param> <returns>The response from the DescribeRouteTables service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeRouteTables(Amazon.EC2.Model.DescribeRouteTablesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeRouteTables operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeRouteTables operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeRouteTables(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeRouteTables operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeRouteTables.</param> <returns>Returns a DescribeRouteTablesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroups"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest)"> <summary> Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups service method.</param> <returns>The response from the DescribeSecurityGroups service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSecurityGroups(Amazon.EC2.Model.DescribeSecurityGroupsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSecurityGroups operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSecurityGroups operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSecurityGroups(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSecurityGroups operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSecurityGroups.</param> <returns>Returns a DescribeSecurityGroupsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest)"> <summary> Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute service method.</param> <returns>The response from the DescribeSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSnapshotAttribute(Amazon.EC2.Model.DescribeSnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshotAttribute.</param> <returns>Returns a DescribeSnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshots"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest)"> <summary> Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots service method.</param> <returns>The response from the DescribeSnapshots service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSnapshots(Amazon.EC2.Model.DescribeSnapshotsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSnapshots operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndDescribeSnapshots(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSnapshots operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSnapshots.</param> <returns>Returns a DescribeSnapshotsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscription"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest)"> <summary> Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription service method.</param> <returns>The response from the DescribeSpotDatafeedSubscription service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotDatafeedSubscription(Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotDatafeedSubscription operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotDatafeedSubscription operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotDatafeedSubscription(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotDatafeedSubscription operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotDatafeedSubscription.</param> <returns>Returns a DescribeSpotDatafeedSubscriptionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest)"> <summary> Describes the running instances for the specified Spot fleet. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances service method.</param> <returns>The response from the DescribeSpotFleetInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotFleetInstances(Amazon.EC2.Model.DescribeSpotFleetInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotFleetInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetInstances.</param> <returns>Returns a DescribeSpotFleetInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest)"> <summary> Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory service method.</param> <returns>The response from the DescribeSpotFleetRequestHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotFleetRequestHistory(Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequestHistory operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetRequestHistory operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotFleetRequestHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetRequestHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetRequestHistory.</param> <returns>Returns a DescribeSpotFleetRequestHistoryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest)"> <summary> Describes your Spot fleet requests. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests service method.</param> <returns>The response from the DescribeSpotFleetRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotFleetRequests(Amazon.EC2.Model.DescribeSpotFleetRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotFleetRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotFleetRequests operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotFleetRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotFleetRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotFleetRequests.</param> <returns>Returns a DescribeSpotFleetRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequests"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest)"> <summary> Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests service method.</param> <returns>The response from the DescribeSpotInstanceRequests service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotInstanceRequests(Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotInstanceRequests operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotInstanceRequests operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotInstanceRequests(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotInstanceRequests operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotInstanceRequests.</param> <returns>Returns a DescribeSpotInstanceRequestsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistory"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest)"> <summary> Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory service method.</param> <returns>The response from the DescribeSpotPriceHistory service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSpotPriceHistory(Amazon.EC2.Model.DescribeSpotPriceHistoryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSpotPriceHistory operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSpotPriceHistory operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSpotPriceHistory(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSpotPriceHistory operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSpotPriceHistory.</param> <returns>Returns a DescribeSpotPriceHistoryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnets"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest)"> <summary> Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets service method.</param> <returns>The response from the DescribeSubnets service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeSubnets(Amazon.EC2.Model.DescribeSubnetsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeSubnets operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeSubnets operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeSubnets operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeSubnets(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeSubnets operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeSubnets.</param> <returns>Returns a DescribeSubnetsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTags"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeTags(Amazon.EC2.Model.DescribeTagsRequest)"> <summary> Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags service method.</param> <returns>The response from the DescribeTags service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeTags(Amazon.EC2.Model.DescribeTagsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTags operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTags operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.EC2.AmazonEC2Client.EndDescribeTags(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTags operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTags.</param> <returns>Returns a DescribeTagsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest)"> <summary> Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute service method.</param> <returns>The response from the DescribeVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVolumeAttribute(Amazon.EC2.Model.DescribeVolumeAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumeAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVolumeAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumeAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumeAttribute.</param> <returns>Returns a DescribeVolumeAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumes"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest)"> <summary> Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes service method.</param> <returns>The response from the DescribeVolumes service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVolumes(Amazon.EC2.Model.DescribeVolumesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumes operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumes operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumes operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVolumes(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumes operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumes.</param> <returns>Returns a DescribeVolumesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatus"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest)"> <summary> Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus service method.</param> <returns>The response from the DescribeVolumeStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVolumeStatus(Amazon.EC2.Model.DescribeVolumeStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVolumeStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVolumeStatus operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVolumeStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVolumeStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVolumeStatus.</param> <returns>Returns a DescribeVolumeStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest)"> <summary> Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute service method.</param> <returns>The response from the DescribeVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcAttribute(Amazon.EC2.Model.DescribeVpcAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcAttribute.</param> <returns>Returns a DescribeVpcAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest)"> <summary> Describes the ClassicLink status of one or more VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink service method.</param> <returns>The response from the DescribeVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcClassicLink(Amazon.EC2.Model.DescribeVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcClassicLink.</param> <returns>Returns a DescribeVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest)"> <summary> Describes one or more of your VPC endpoints. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints service method.</param> <returns>The response from the DescribeVpcEndpoints service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcEndpoints(Amazon.EC2.Model.DescribeVpcEndpointsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpoints operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcEndpoints operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcEndpoints(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcEndpoints operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcEndpoints.</param> <returns>Returns a DescribeVpcEndpointsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest)"> <summary> Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices service method.</param> <returns>The response from the DescribeVpcEndpointServices service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcEndpointServices(Amazon.EC2.Model.DescribeVpcEndpointServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcEndpointServices operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcEndpointServices operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcEndpointServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcEndpointServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcEndpointServices.</param> <returns>Returns a DescribeVpcEndpointServicesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnections"> <summary> Describes one or more of your VPC peering connections. </summary> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest)"> <summary> Describes one or more of your VPC peering connections. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections service method.</param> <returns>The response from the DescribeVpcPeeringConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcPeeringConnections(Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcPeeringConnections operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcPeeringConnections operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcPeeringConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcPeeringConnections operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcPeeringConnections.</param> <returns>Returns a DescribeVpcPeeringConnectionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcs"> <summary> Describes one or more of your VPCs. </summary> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest)"> <summary> Describes one or more of your VPCs. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs service method.</param> <returns>The response from the DescribeVpcs service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpcs(Amazon.EC2.Model.DescribeVpcsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpcs operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpcs operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpcs operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpcs(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpcs operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpcs.</param> <returns>Returns a DescribeVpcsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnections"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest)"> <summary> Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections service method.</param> <returns>The response from the DescribeVpnConnections service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpnConnections(Amazon.EC2.Model.DescribeVpnConnectionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnConnections operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpnConnections operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpnConnections(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpnConnections operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpnConnections.</param> <returns>Returns a DescribeVpnConnectionsResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGateways"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest)"> <summary> Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways service method.</param> <returns>The response from the DescribeVpnGateways service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDescribeVpnGateways(Amazon.EC2.Model.DescribeVpnGatewaysRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeVpnGateways operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeVpnGateways operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDescribeVpnGateways(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeVpnGateways operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeVpnGateways.</param> <returns>Returns a DescribeVpnGatewaysResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest)"> <summary> Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc service method.</param> <returns>The response from the DetachClassicLinkVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDetachClassicLinkVpc(Amazon.EC2.Model.DetachClassicLinkVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachClassicLinkVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachClassicLinkVpc operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDetachClassicLinkVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachClassicLinkVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachClassicLinkVpc.</param> <returns>Returns a DetachClassicLinkVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest)"> <summary> Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway service method.</param> <returns>The response from the DetachInternetGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDetachInternetGateway(Amazon.EC2.Model.DetachInternetGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachInternetGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachInternetGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDetachInternetGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachInternetGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachInternetGateway.</param> <returns>Returns a DetachInternetGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest)"> <summary> Detaches a network interface from an instance. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface service method.</param> <returns>The response from the DetachNetworkInterface service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDetachNetworkInterface(Amazon.EC2.Model.DetachNetworkInterfaceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachNetworkInterface operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachNetworkInterface operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDetachNetworkInterface(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachNetworkInterface operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachNetworkInterface.</param> <returns>Returns a DetachNetworkInterfaceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVolume(Amazon.EC2.Model.DetachVolumeRequest)"> <summary> Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para> <para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume service method.</param> <returns>The response from the DetachVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDetachVolume(Amazon.EC2.Model.DetachVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachVolume operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDetachVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachVolume.</param> <returns>Returns a DetachVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest)"> <summary> Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway service method.</param> <returns>The response from the DetachVpnGateway service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDetachVpnGateway(Amazon.EC2.Model.DetachVpnGatewayRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="request">Container for the necessary parameters to execute the DetachVpnGateway operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDetachVpnGateway operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDetachVpnGateway(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DetachVpnGateway operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDetachVpnGateway.</param> <returns>Returns a DetachVpnGatewayResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest)"> <summary> Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation service method.</param> <returns>The response from the DisableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDisableVgwRoutePropagation(Amazon.EC2.Model.DisableVgwRoutePropagationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVgwRoutePropagation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableVgwRoutePropagation operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDisableVgwRoutePropagation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableVgwRoutePropagation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableVgwRoutePropagation.</param> <returns>Returns a DisableVgwRoutePropagationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest)"> <summary> Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink service method.</param> <returns>The response from the DisableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDisableVpcClassicLink(Amazon.EC2.Model.DisableVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the DisableVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisableVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDisableVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisableVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisableVpcClassicLink.</param> <returns>Returns a DisableVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest)"> <summary> Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress service method.</param> <returns>The response from the DisassociateAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDisassociateAddress(Amazon.EC2.Model.DisassociateAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisassociateAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateAddress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDisassociateAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisassociateAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisassociateAddress.</param> <returns>Returns a DisassociateAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest)"> <summary> Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable service method.</param> <returns>The response from the DisassociateRouteTable service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginDisassociateRouteTable(Amazon.EC2.Model.DisassociateRouteTableRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="request">Container for the necessary parameters to execute the DisassociateRouteTable operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDisassociateRouteTable operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndDisassociateRouteTable(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DisassociateRouteTable operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDisassociateRouteTable.</param> <returns>Returns a DisassociateRouteTableResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest)"> <summary> Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation service method.</param> <returns>The response from the EnableVgwRoutePropagation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginEnableVgwRoutePropagation(Amazon.EC2.Model.EnableVgwRoutePropagationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVgwRoutePropagation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVgwRoutePropagation operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndEnableVgwRoutePropagation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVgwRoutePropagation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVgwRoutePropagation.</param> <returns>Returns a EnableVgwRoutePropagationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest)"> <summary> Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO service method.</param> <returns>The response from the EnableVolumeIO service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginEnableVolumeIO(Amazon.EC2.Model.EnableVolumeIORequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVolumeIO operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVolumeIO operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndEnableVolumeIO(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVolumeIO operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVolumeIO.</param> <returns>Returns a EnableVolumeIOResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest)"> <summary> Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink service method.</param> <returns>The response from the EnableVpcClassicLink service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginEnableVpcClassicLink(Amazon.EC2.Model.EnableVpcClassicLinkRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="request">Container for the necessary parameters to execute the EnableVpcClassicLink operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndEnableVpcClassicLink operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndEnableVpcClassicLink(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the EnableVpcClassicLink operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginEnableVpcClassicLink.</param> <returns>Returns a EnableVpcClassicLinkResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest)"> <summary> Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para> <para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para> <para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para> <para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput service method.</param> <returns>The response from the GetConsoleOutput service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginGetConsoleOutput(Amazon.EC2.Model.GetConsoleOutputRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="request">Container for the necessary parameters to execute the GetConsoleOutput operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetConsoleOutput operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndGetConsoleOutput(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetConsoleOutput operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetConsoleOutput.</param> <returns>Returns a GetConsoleOutputResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.GetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest)"> <summary> Retrieves the encrypted administrator password for an instance running Windows. <para> The Windows password is generated at boot if the <code>EC2Config</code> service plugin, <code>Ec2SetPassword</code>, is enabled. This usually only happens the first time an AMI is launched, and then <code>Ec2SetPassword</code> is automatically disabled. The password is not generated for rebundled AMIs unless <code>Ec2SetPassword</code> is enabled before bundling. </para> <para> The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. </para> <para> Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData service method.</param> <returns>The response from the GetPasswordData service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginGetPasswordData(Amazon.EC2.Model.GetPasswordDataRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the GetPasswordData operation. </summary> <param name="request">Container for the necessary parameters to execute the GetPasswordData operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetPasswordData operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndGetPasswordData(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the GetPasswordData operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginGetPasswordData.</param> <returns>Returns a GetPasswordDataResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportImage(Amazon.EC2.Model.ImportImageRequest)"> <summary> Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> <param name="request">Container for the necessary parameters to execute the ImportImage service method.</param> <returns>The response from the ImportImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginImportImage(Amazon.EC2.Model.ImportImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportImage operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportImage operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndImportImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportImage.</param> <returns>Returns a ImportImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportInstance(Amazon.EC2.Model.ImportInstanceRequest)"> <summary> Creates an import instance task using metadata from the specified disk image. <code>ImportInstance</code> only supports single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a>. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the EC2 command line tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance service method.</param> <returns>The response from the ImportInstance service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginImportInstance(Amazon.EC2.Model.ImportInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportInstance operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportInstance operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndImportInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportInstance.</param> <returns>Returns a ImportInstanceResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest)"> <summary> Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair service method.</param> <returns>The response from the ImportKeyPair service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginImportKeyPair(Amazon.EC2.Model.ImportKeyPairRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportKeyPair operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportKeyPair operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportKeyPair operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndImportKeyPair(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportKeyPair operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportKeyPair.</param> <returns>Returns a ImportKeyPairResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest)"> <summary> Imports a disk into an EBS snapshot. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot service method.</param> <returns>The response from the ImportSnapshot service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginImportSnapshot(Amazon.EC2.Model.ImportSnapshotRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportSnapshot operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportSnapshot operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportSnapshot operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndImportSnapshot(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportSnapshot operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportSnapshot.</param> <returns>Returns a ImportSnapshotResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ImportVolume(Amazon.EC2.Model.ImportVolumeRequest)"> <summary> Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the Amazon EC2 command-line interface (CLI) tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume service method.</param> <returns>The response from the ImportVolume service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginImportVolume(Amazon.EC2.Model.ImportVolumeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ImportVolume operation. </summary> <param name="request">Container for the necessary parameters to execute the ImportVolume operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndImportVolume operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndImportVolume(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ImportVolume operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginImportVolume.</param> <returns>Returns a ImportVolumeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest)"> <summary> Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note> <para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute service method.</param> <returns>The response from the ModifyImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyImageAttribute(Amazon.EC2.Model.ModifyImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyImageAttribute.</param> <returns>Returns a ModifyImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest)"> <summary> Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute service method.</param> <returns>The response from the ModifyInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyInstanceAttribute(Amazon.EC2.Model.ModifyInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyInstanceAttribute.</param> <returns>Returns a ModifyInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest)"> <summary> Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute service method.</param> <returns>The response from the ModifyNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyNetworkInterfaceAttribute(Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyNetworkInterfaceAttribute.</param> <returns>Returns a ModifyNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest)"> <summary> Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances service method.</param> <returns>The response from the ModifyReservedInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyReservedInstances(Amazon.EC2.Model.ModifyReservedInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyReservedInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyReservedInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyReservedInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyReservedInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyReservedInstances.</param> <returns>Returns a ModifyReservedInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest)"> <summary> Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> <para> Snapshots with AWS Marketplace product codes cannot be made public. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute service method.</param> <returns>The response from the ModifySnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifySnapshotAttribute(Amazon.EC2.Model.ModifySnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifySnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifySnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifySnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifySnapshotAttribute.</param> <returns>Returns a ModifySnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest)"> <summary> Modifies a subnet attribute. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute service method.</param> <returns>The response from the ModifySubnetAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifySubnetAttribute(Amazon.EC2.Model.ModifySubnetAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifySubnetAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifySubnetAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifySubnetAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifySubnetAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifySubnetAttribute.</param> <returns>Returns a ModifySubnetAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest)"> <summary> Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para> <para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute service method.</param> <returns>The response from the ModifyVolumeAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyVolumeAttribute(Amazon.EC2.Model.ModifyVolumeAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVolumeAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVolumeAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyVolumeAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVolumeAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVolumeAttribute.</param> <returns>Returns a ModifyVolumeAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest)"> <summary> Modifies the specified attribute of the specified VPC. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute service method.</param> <returns>The response from the ModifyVpcAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyVpcAttribute(Amazon.EC2.Model.ModifyVpcAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVpcAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyVpcAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVpcAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVpcAttribute.</param> <returns>Returns a ModifyVpcAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest)"> <summary> Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint service method.</param> <returns>The response from the ModifyVpcEndpoint service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginModifyVpcEndpoint(Amazon.EC2.Model.ModifyVpcEndpointRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="request">Container for the necessary parameters to execute the ModifyVpcEndpoint operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndModifyVpcEndpoint operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndModifyVpcEndpoint(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ModifyVpcEndpoint operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginModifyVpcEndpoint.</param> <returns>Returns a ModifyVpcEndpointResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest)"> <summary> Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances service method.</param> <returns>The response from the MonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginMonitorInstances(Amazon.EC2.Model.MonitorInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the MonitorInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMonitorInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndMonitorInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MonitorInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMonitorInstances.</param> <returns>Returns a MonitorInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.MoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest)"> <summary> Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc service method.</param> <returns>The response from the MoveAddressToVpc service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginMoveAddressToVpc(Amazon.EC2.Model.MoveAddressToVpcRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="request">Container for the necessary parameters to execute the MoveAddressToVpc operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndMoveAddressToVpc operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndMoveAddressToVpc(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the MoveAddressToVpc operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginMoveAddressToVpc.</param> <returns>Returns a MoveAddressToVpcResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.PurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest)"> <summary> Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering service method.</param> <returns>The response from the PurchaseReservedInstancesOffering service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginPurchaseReservedInstancesOffering(Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="request">Container for the necessary parameters to execute the PurchaseReservedInstancesOffering operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPurchaseReservedInstancesOffering operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndPurchaseReservedInstancesOffering(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the PurchaseReservedInstancesOffering operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginPurchaseReservedInstancesOffering.</param> <returns>Returns a PurchaseReservedInstancesOfferingResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RebootInstances(Amazon.EC2.Model.RebootInstancesRequest)"> <summary> Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances service method.</param> <returns>The response from the RebootInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRebootInstances(Amazon.EC2.Model.RebootInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RebootInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RebootInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRebootInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRebootInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RebootInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRebootInstances.</param> <returns>Returns a RebootInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RegisterImage(Amazon.EC2.Model.RegisterImageRequest)"> <summary> Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note> <para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> </note> <para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <important> <para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para> <para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para> <para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para> </important> <para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para> <note> <para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage service method.</param> <returns>The response from the RegisterImage service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRegisterImage(Amazon.EC2.Model.RegisterImageRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterImage operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterImage operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterImage operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRegisterImage(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterImage operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterImage.</param> <returns>Returns a RegisterImageResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest)"> <summary> Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection service method.</param> <returns>The response from the RejectVpcPeeringConnection service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRejectVpcPeeringConnection(Amazon.EC2.Model.RejectVpcPeeringConnectionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="request">Container for the necessary parameters to execute the RejectVpcPeeringConnection operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRejectVpcPeeringConnection operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRejectVpcPeeringConnection(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RejectVpcPeeringConnection operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRejectVpcPeeringConnection.</param> <returns>Returns a RejectVpcPeeringConnectionResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest)"> <summary> Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para> <para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para> <para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress service method.</param> <returns>The response from the ReleaseAddress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReleaseAddress(Amazon.EC2.Model.ReleaseAddressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReleaseAddress operation. </summary> <param name="request">Container for the necessary parameters to execute the ReleaseAddress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReleaseAddress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReleaseAddress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReleaseAddress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReleaseAddress.</param> <returns>Returns a ReleaseAddressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest)"> <summary> Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation service method.</param> <returns>The response from the ReplaceNetworkAclAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReplaceNetworkAclAssociation(Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclAssociation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceNetworkAclAssociation operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReplaceNetworkAclAssociation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceNetworkAclAssociation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceNetworkAclAssociation.</param> <returns>Returns a ReplaceNetworkAclAssociationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest)"> <summary> Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry service method.</param> <returns>The response from the ReplaceNetworkAclEntry service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReplaceNetworkAclEntry(Amazon.EC2.Model.ReplaceNetworkAclEntryRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceNetworkAclEntry operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceNetworkAclEntry operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReplaceNetworkAclEntry(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceNetworkAclEntry operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceNetworkAclEntry.</param> <returns>Returns a ReplaceNetworkAclEntryResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest)"> <summary> Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute service method.</param> <returns>The response from the ReplaceRoute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReplaceRoute(Amazon.EC2.Model.ReplaceRouteRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceRoute operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRoute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceRoute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReplaceRoute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceRoute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceRoute.</param> <returns>Returns a ReplaceRouteResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest)"> <summary> Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation service method.</param> <returns>The response from the ReplaceRouteTableAssociation service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReplaceRouteTableAssociation(Amazon.EC2.Model.ReplaceRouteTableAssociationRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="request">Container for the necessary parameters to execute the ReplaceRouteTableAssociation operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReplaceRouteTableAssociation operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReplaceRouteTableAssociation(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReplaceRouteTableAssociation operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReplaceRouteTableAssociation.</param> <returns>Returns a ReplaceRouteTableAssociationResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest)"> <summary> Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus service method.</param> <returns>The response from the ReportInstanceStatus service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginReportInstanceStatus(Amazon.EC2.Model.ReportInstanceStatusRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="request">Container for the necessary parameters to execute the ReportInstanceStatus operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndReportInstanceStatus operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndReportInstanceStatus(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ReportInstanceStatus operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginReportInstanceStatus.</param> <returns>Returns a ReportInstanceStatusResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest)"> <summary> Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para> <para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para> <para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet service method.</param> <returns>The response from the RequestSpotFleet service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRequestSpotFleet(Amazon.EC2.Model.RequestSpotFleetRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotFleet operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestSpotFleet operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRequestSpotFleet(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestSpotFleet operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestSpotFleet.</param> <returns>Returns a RequestSpotFleetResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest)"> <summary> Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances service method.</param> <returns>The response from the RequestSpotInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRequestSpotInstances(Amazon.EC2.Model.RequestSpotInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RequestSpotInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestSpotInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRequestSpotInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RequestSpotInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRequestSpotInstances.</param> <returns>Returns a RequestSpotInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest)"> <summary> Resets an attribute of an AMI to its default value. <note> <para> The productCodes attribute can't be reset. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute service method.</param> <returns>The response from the ResetImageAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginResetImageAttribute(Amazon.EC2.Model.ResetImageAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetImageAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetImageAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndResetImageAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetImageAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetImageAttribute.</param> <returns>Returns a ResetImageAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest)"> <summary> Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute service method.</param> <returns>The response from the ResetInstanceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginResetInstanceAttribute(Amazon.EC2.Model.ResetInstanceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetInstanceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetInstanceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndResetInstanceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetInstanceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetInstanceAttribute.</param> <returns>Returns a ResetInstanceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest)"> <summary> Resets a network interface attribute. You can specify only one attribute at a time. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute service method.</param> <returns>The response from the ResetNetworkInterfaceAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginResetNetworkInterfaceAttribute(Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetNetworkInterfaceAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetNetworkInterfaceAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndResetNetworkInterfaceAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetNetworkInterfaceAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetNetworkInterfaceAttribute.</param> <returns>Returns a ResetNetworkInterfaceAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.ResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest)"> <summary> Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute service method.</param> <returns>The response from the ResetSnapshotAttribute service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginResetSnapshotAttribute(Amazon.EC2.Model.ResetSnapshotAttributeRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="request">Container for the necessary parameters to execute the ResetSnapshotAttribute operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetSnapshotAttribute operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndResetSnapshotAttribute(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ResetSnapshotAttribute operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginResetSnapshotAttribute.</param> <returns>Returns a ResetSnapshotAttributeResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest)"> <summary> Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic service method.</param> <returns>The response from the RestoreAddressToClassic service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRestoreAddressToClassic(Amazon.EC2.Model.RestoreAddressToClassicRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="request">Container for the necessary parameters to execute the RestoreAddressToClassic operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRestoreAddressToClassic operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRestoreAddressToClassic(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RestoreAddressToClassic operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRestoreAddressToClassic.</param> <returns>Returns a RestoreAddressToClassicResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest)"> <summary> Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress service method.</param> <returns>The response from the RevokeSecurityGroupEgress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRevokeSecurityGroupEgress(Amazon.EC2.Model.RevokeSecurityGroupEgressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupEgress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeSecurityGroupEgress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRevokeSecurityGroupEgress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeSecurityGroupEgress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeSecurityGroupEgress.</param> <returns>Returns a RevokeSecurityGroupEgressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest)"> <summary> Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress service method.</param> <returns>The response from the RevokeSecurityGroupIngress service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRevokeSecurityGroupIngress(Amazon.EC2.Model.RevokeSecurityGroupIngressRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="request">Container for the necessary parameters to execute the RevokeSecurityGroupIngress operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRevokeSecurityGroupIngress operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRevokeSecurityGroupIngress(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RevokeSecurityGroupIngress operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRevokeSecurityGroupIngress.</param> <returns>Returns a RevokeSecurityGroupIngressResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.RunInstances(Amazon.EC2.Model.RunInstancesRequest)"> <summary> Launches the specified number of instances using an AMI for which you have permissions. <para> When you launch an instance, it enters the <code>pending</code> state. After the instance is ready for you, it enters the <code>running</code> state. To check the state of your instance, call <a>DescribeInstances</a>. </para> <para> If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you. </para> <para> [EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you. </para> <para> Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> You can provide optional user data when launching an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If any of the AMIs have a product code attached for which the user has not subscribed, <code>RunInstances</code> fails. </para> <para> T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, <code>RunInstances</code> fails. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What To Do If An Instance Immediately Terminates</a>, and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the RunInstances service method.</param> <returns>The response from the RunInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginRunInstances(Amazon.EC2.Model.RunInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the RunInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndRunInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunInstances.</param> <returns>Returns a RunInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StartInstances(Amazon.EC2.Model.StartInstancesRequest)"> <summary> Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StartInstances service method.</param> <returns>The response from the StartInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginStartInstances(Amazon.EC2.Model.StartInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StartInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndStartInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartInstances.</param> <returns>Returns a StartInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.StopInstances(Amazon.EC2.Model.StopInstancesRequest)"> <summary> Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. <para> You can't start or stop Spot Instances. </para> <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshooting Stopping Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopInstances service method.</param> <returns>The response from the StopInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginStopInstances(Amazon.EC2.Model.StopInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the StopInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndStopInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopInstances.</param> <returns>Returns a StopInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.TerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest)"> <summary> Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. <para> Terminated instances remain visible after termination (for approximately one hour). </para> <para> By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances service method.</param> <returns>The response from the TerminateInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginTerminateInstances(Amazon.EC2.Model.TerminateInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the TerminateInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the TerminateInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndTerminateInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the TerminateInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginTerminateInstances.</param> <returns>Returns a TerminateInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest)"> <summary> Unassigns one or more secondary private IP addresses from a network interface. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses service method.</param> <returns>The response from the UnassignPrivateIpAddresses service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginUnassignPrivateIpAddresses(Amazon.EC2.Model.UnassignPrivateIpAddressesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="request">Container for the necessary parameters to execute the UnassignPrivateIpAddresses operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnassignPrivateIpAddresses operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndUnassignPrivateIpAddresses(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnassignPrivateIpAddresses operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnassignPrivateIpAddresses.</param> <returns>Returns a UnassignPrivateIpAddressesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.UnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest)"> <summary> Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances service method.</param> <returns>The response from the UnmonitorInstances service method, as returned by EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.BeginUnmonitorInstances(Amazon.EC2.Model.UnmonitorInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the UnmonitorInstances operation on AmazonEC2Client.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnmonitorInstances operation.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.EndUnmonitorInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UnmonitorInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUnmonitorInstances.</param> <returns>Returns a UnmonitorInstancesResult from EC2.</returns> </member> <member name="M:Amazon.EC2.AmazonEC2Client.DryRun(Amazon.EC2.AmazonEC2Request)"> <summary> Checks whether you have the required permissions for the action, without actually making the request. </summary> <param name="request">Request to do a dry run of.</param> <returns>Result of the dry run.</returns> </member> <member name="T:Amazon.EC2.AmazonEC2Config"> <summary> Configuration for accessing Amazon EC2 service </summary> </member> <member name="M:Amazon.EC2.AmazonEC2Config.#ctor"> <summary> Default constructor </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.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.EC2.AccountAttributeName"> <summary> Constants used for properties of type AccountAttributeName. </summary> </member> <member name="F:Amazon.EC2.AccountAttributeName.DefaultVpc"> <summary> Constant DefaultVpc for AccountAttributeName </summary> </member> <member name="F:Amazon.EC2.AccountAttributeName.SupportedPlatforms"> <summary> Constant SupportedPlatforms for AccountAttributeName </summary> </member> <member name="M:Amazon.EC2.AccountAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.AccountAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.AllocationStrategy"> <summary> Constants used for properties of type AllocationStrategy. </summary> </member> <member name="F:Amazon.EC2.AllocationStrategy.Diversified"> <summary> Constant Diversified for AllocationStrategy </summary> </member> <member name="F:Amazon.EC2.AllocationStrategy.LowestPrice"> <summary> Constant LowestPrice for AllocationStrategy </summary> </member> <member name="M:Amazon.EC2.AllocationStrategy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.AllocationStrategy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ArchitectureValues"> <summary> Constants used for properties of type ArchitectureValues. </summary> </member> <member name="F:Amazon.EC2.ArchitectureValues.I386"> <summary> Constant I386 for ArchitectureValues </summary> </member> <member name="F:Amazon.EC2.ArchitectureValues.X86_64"> <summary> Constant X86_64 for ArchitectureValues </summary> </member> <member name="M:Amazon.EC2.ArchitectureValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ArchitectureValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.AttachmentStatus"> <summary> Constants used for properties of type AttachmentStatus. </summary> </member> <member name="F:Amazon.EC2.AttachmentStatus.Attached"> <summary> Constant Attached for AttachmentStatus </summary> </member> <member name="F:Amazon.EC2.AttachmentStatus.Attaching"> <summary> Constant Attaching for AttachmentStatus </summary> </member> <member name="F:Amazon.EC2.AttachmentStatus.Detached"> <summary> Constant Detached for AttachmentStatus </summary> </member> <member name="F:Amazon.EC2.AttachmentStatus.Detaching"> <summary> Constant Detaching for AttachmentStatus </summary> </member> <member name="M:Amazon.EC2.AttachmentStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.AttachmentStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.AvailabilityZoneState"> <summary> Constants used for properties of type AvailabilityZoneState. </summary> </member> <member name="F:Amazon.EC2.AvailabilityZoneState.Available"> <summary> Constant Available for AvailabilityZoneState </summary> </member> <member name="M:Amazon.EC2.AvailabilityZoneState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.AvailabilityZoneState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.BatchState"> <summary> Constants used for properties of type BatchState. </summary> </member> <member name="F:Amazon.EC2.BatchState.Active"> <summary> Constant Active for BatchState </summary> </member> <member name="F:Amazon.EC2.BatchState.Cancelled"> <summary> Constant Cancelled for BatchState </summary> </member> <member name="F:Amazon.EC2.BatchState.Cancelled_running"> <summary> Constant Cancelled_running for BatchState </summary> </member> <member name="F:Amazon.EC2.BatchState.Cancelled_terminating"> <summary> Constant Cancelled_terminating for BatchState </summary> </member> <member name="F:Amazon.EC2.BatchState.Failed"> <summary> Constant Failed for BatchState </summary> </member> <member name="F:Amazon.EC2.BatchState.Submitted"> <summary> Constant Submitted for BatchState </summary> </member> <member name="M:Amazon.EC2.BatchState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.BatchState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.BundleTaskState"> <summary> Constants used for properties of type BundleTaskState. </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Bundling"> <summary> Constant Bundling for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Cancelling"> <summary> Constant Cancelling for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Complete"> <summary> Constant Complete for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Failed"> <summary> Constant Failed for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Pending"> <summary> Constant Pending for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.Storing"> <summary> Constant Storing for BundleTaskState </summary> </member> <member name="F:Amazon.EC2.BundleTaskState.WaitingForShutdown"> <summary> Constant WaitingForShutdown for BundleTaskState </summary> </member> <member name="M:Amazon.EC2.BundleTaskState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.BundleTaskState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.CancelBatchErrorCode"> <summary> Constants used for properties of type CancelBatchErrorCode. </summary> </member> <member name="F:Amazon.EC2.CancelBatchErrorCode.FleetRequestIdDoesNotExist"> <summary> Constant FleetRequestIdDoesNotExist for CancelBatchErrorCode </summary> </member> <member name="F:Amazon.EC2.CancelBatchErrorCode.FleetRequestIdMalformed"> <summary> Constant FleetRequestIdMalformed for CancelBatchErrorCode </summary> </member> <member name="F:Amazon.EC2.CancelBatchErrorCode.FleetRequestNotInCancellableState"> <summary> Constant FleetRequestNotInCancellableState for CancelBatchErrorCode </summary> </member> <member name="F:Amazon.EC2.CancelBatchErrorCode.UnexpectedError"> <summary> Constant UnexpectedError for CancelBatchErrorCode </summary> </member> <member name="M:Amazon.EC2.CancelBatchErrorCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.CancelBatchErrorCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.CancelSpotInstanceRequestState"> <summary> Constants used for properties of type CancelSpotInstanceRequestState. </summary> </member> <member name="F:Amazon.EC2.CancelSpotInstanceRequestState.Active"> <summary> Constant Active for CancelSpotInstanceRequestState </summary> </member> <member name="F:Amazon.EC2.CancelSpotInstanceRequestState.Cancelled"> <summary> Constant Cancelled for CancelSpotInstanceRequestState </summary> </member> <member name="F:Amazon.EC2.CancelSpotInstanceRequestState.Closed"> <summary> Constant Closed for CancelSpotInstanceRequestState </summary> </member> <member name="F:Amazon.EC2.CancelSpotInstanceRequestState.Completed"> <summary> Constant Completed for CancelSpotInstanceRequestState </summary> </member> <member name="F:Amazon.EC2.CancelSpotInstanceRequestState.Open"> <summary> Constant Open for CancelSpotInstanceRequestState </summary> </member> <member name="M:Amazon.EC2.CancelSpotInstanceRequestState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.CancelSpotInstanceRequestState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ContainerFormat"> <summary> Constants used for properties of type ContainerFormat. </summary> </member> <member name="F:Amazon.EC2.ContainerFormat.Ova"> <summary> Constant Ova for ContainerFormat </summary> </member> <member name="M:Amazon.EC2.ContainerFormat.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ContainerFormat.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ConversionTaskState"> <summary> Constants used for properties of type ConversionTaskState. </summary> </member> <member name="F:Amazon.EC2.ConversionTaskState.Active"> <summary> Constant Active for ConversionTaskState </summary> </member> <member name="F:Amazon.EC2.ConversionTaskState.Cancelled"> <summary> Constant Cancelled for ConversionTaskState </summary> </member> <member name="F:Amazon.EC2.ConversionTaskState.Cancelling"> <summary> Constant Cancelling for ConversionTaskState </summary> </member> <member name="F:Amazon.EC2.ConversionTaskState.Completed"> <summary> Constant Completed for ConversionTaskState </summary> </member> <member name="M:Amazon.EC2.ConversionTaskState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ConversionTaskState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.CurrencyCodeValues"> <summary> Constants used for properties of type CurrencyCodeValues. </summary> </member> <member name="F:Amazon.EC2.CurrencyCodeValues.USD"> <summary> Constant USD for CurrencyCodeValues </summary> </member> <member name="M:Amazon.EC2.CurrencyCodeValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.CurrencyCodeValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.DatafeedSubscriptionState"> <summary> Constants used for properties of type DatafeedSubscriptionState. </summary> </member> <member name="F:Amazon.EC2.DatafeedSubscriptionState.Active"> <summary> Constant Active for DatafeedSubscriptionState </summary> </member> <member name="F:Amazon.EC2.DatafeedSubscriptionState.Inactive"> <summary> Constant Inactive for DatafeedSubscriptionState </summary> </member> <member name="M:Amazon.EC2.DatafeedSubscriptionState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.DatafeedSubscriptionState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.DeviceType"> <summary> Constants used for properties of type DeviceType. </summary> </member> <member name="F:Amazon.EC2.DeviceType.Ebs"> <summary> Constant Ebs for DeviceType </summary> </member> <member name="F:Amazon.EC2.DeviceType.InstanceStore"> <summary> Constant InstanceStore for DeviceType </summary> </member> <member name="M:Amazon.EC2.DeviceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.DeviceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.DiskImageFormat"> <summary> Constants used for properties of type DiskImageFormat. </summary> </member> <member name="F:Amazon.EC2.DiskImageFormat.RAW"> <summary> Constant RAW for DiskImageFormat </summary> </member> <member name="F:Amazon.EC2.DiskImageFormat.VHD"> <summary> Constant VHD for DiskImageFormat </summary> </member> <member name="F:Amazon.EC2.DiskImageFormat.VMDK"> <summary> Constant VMDK for DiskImageFormat </summary> </member> <member name="M:Amazon.EC2.DiskImageFormat.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.DiskImageFormat.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.DomainType"> <summary> Constants used for properties of type DomainType. </summary> </member> <member name="F:Amazon.EC2.DomainType.Standard"> <summary> Constant Standard for DomainType </summary> </member> <member name="F:Amazon.EC2.DomainType.Vpc"> <summary> Constant Vpc for DomainType </summary> </member> <member name="M:Amazon.EC2.DomainType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.DomainType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.EventCode"> <summary> Constants used for properties of type EventCode. </summary> </member> <member name="F:Amazon.EC2.EventCode.InstanceReboot"> <summary> Constant InstanceReboot for EventCode </summary> </member> <member name="F:Amazon.EC2.EventCode.InstanceRetirement"> <summary> Constant InstanceRetirement for EventCode </summary> </member> <member name="F:Amazon.EC2.EventCode.InstanceStop"> <summary> Constant InstanceStop for EventCode </summary> </member> <member name="F:Amazon.EC2.EventCode.SystemMaintenance"> <summary> Constant SystemMaintenance for EventCode </summary> </member> <member name="F:Amazon.EC2.EventCode.SystemReboot"> <summary> Constant SystemReboot for EventCode </summary> </member> <member name="M:Amazon.EC2.EventCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.EventCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.EventType"> <summary> Constants used for properties of type EventType. </summary> </member> <member name="F:Amazon.EC2.EventType.Error"> <summary> Constant Error for EventType </summary> </member> <member name="F:Amazon.EC2.EventType.FleetRequestChange"> <summary> Constant FleetRequestChange for EventType </summary> </member> <member name="F:Amazon.EC2.EventType.InstanceChange"> <summary> Constant InstanceChange for EventType </summary> </member> <member name="M:Amazon.EC2.EventType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.EventType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ExportEnvironment"> <summary> Constants used for properties of type ExportEnvironment. </summary> </member> <member name="F:Amazon.EC2.ExportEnvironment.Citrix"> <summary> Constant Citrix for ExportEnvironment </summary> </member> <member name="F:Amazon.EC2.ExportEnvironment.Microsoft"> <summary> Constant Microsoft for ExportEnvironment </summary> </member> <member name="F:Amazon.EC2.ExportEnvironment.Vmware"> <summary> Constant Vmware for ExportEnvironment </summary> </member> <member name="M:Amazon.EC2.ExportEnvironment.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ExportEnvironment.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ExportTaskState"> <summary> Constants used for properties of type ExportTaskState. </summary> </member> <member name="F:Amazon.EC2.ExportTaskState.Active"> <summary> Constant Active for ExportTaskState </summary> </member> <member name="F:Amazon.EC2.ExportTaskState.Cancelled"> <summary> Constant Cancelled for ExportTaskState </summary> </member> <member name="F:Amazon.EC2.ExportTaskState.Cancelling"> <summary> Constant Cancelling for ExportTaskState </summary> </member> <member name="F:Amazon.EC2.ExportTaskState.Completed"> <summary> Constant Completed for ExportTaskState </summary> </member> <member name="M:Amazon.EC2.ExportTaskState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ExportTaskState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.FlowLogsResourceType"> <summary> Constants used for properties of type FlowLogsResourceType. </summary> </member> <member name="F:Amazon.EC2.FlowLogsResourceType.NetworkInterface"> <summary> Constant NetworkInterface for FlowLogsResourceType </summary> </member> <member name="F:Amazon.EC2.FlowLogsResourceType.Subnet"> <summary> Constant Subnet for FlowLogsResourceType </summary> </member> <member name="F:Amazon.EC2.FlowLogsResourceType.VPC"> <summary> Constant VPC for FlowLogsResourceType </summary> </member> <member name="M:Amazon.EC2.FlowLogsResourceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.FlowLogsResourceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.GatewayType"> <summary> Constants used for properties of type GatewayType. </summary> </member> <member name="F:Amazon.EC2.GatewayType.Ipsec1"> <summary> Constant Ipsec1 for GatewayType </summary> </member> <member name="M:Amazon.EC2.GatewayType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.GatewayType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.HypervisorType"> <summary> Constants used for properties of type HypervisorType. </summary> </member> <member name="F:Amazon.EC2.HypervisorType.Ovm"> <summary> Constant Ovm for HypervisorType </summary> </member> <member name="F:Amazon.EC2.HypervisorType.Xen"> <summary> Constant Xen for HypervisorType </summary> </member> <member name="M:Amazon.EC2.HypervisorType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.HypervisorType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ImageAttributeName"> <summary> Constants used for properties of type ImageAttributeName. </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.BlockDeviceMapping"> <summary> Constant BlockDeviceMapping for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.Description"> <summary> Constant Description for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.Kernel"> <summary> Constant Kernel for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.LaunchPermission"> <summary> Constant LaunchPermission for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.ProductCodes"> <summary> Constant ProductCodes for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.Ramdisk"> <summary> Constant Ramdisk for ImageAttributeName </summary> </member> <member name="F:Amazon.EC2.ImageAttributeName.SriovNetSupport"> <summary> Constant SriovNetSupport for ImageAttributeName </summary> </member> <member name="M:Amazon.EC2.ImageAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ImageAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ImageState"> <summary> Constants used for properties of type ImageState. </summary> </member> <member name="F:Amazon.EC2.ImageState.Available"> <summary> Constant Available for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Deregistered"> <summary> Constant Deregistered for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Error"> <summary> Constant Error for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Failed"> <summary> Constant Failed for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Invalid"> <summary> Constant Invalid for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Pending"> <summary> Constant Pending for ImageState </summary> </member> <member name="F:Amazon.EC2.ImageState.Transient"> <summary> Constant Transient for ImageState </summary> </member> <member name="M:Amazon.EC2.ImageState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ImageState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ImageTypeValues"> <summary> Constants used for properties of type ImageTypeValues. </summary> </member> <member name="F:Amazon.EC2.ImageTypeValues.Kernel"> <summary> Constant Kernel for ImageTypeValues </summary> </member> <member name="F:Amazon.EC2.ImageTypeValues.Machine"> <summary> Constant Machine for ImageTypeValues </summary> </member> <member name="F:Amazon.EC2.ImageTypeValues.Ramdisk"> <summary> Constant Ramdisk for ImageTypeValues </summary> </member> <member name="M:Amazon.EC2.ImageTypeValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ImageTypeValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.InstanceAttributeName"> <summary> Constants used for properties of type InstanceAttributeName. </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.BlockDeviceMapping"> <summary> Constant BlockDeviceMapping for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.DisableApiTermination"> <summary> Constant DisableApiTermination for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.EbsOptimized"> <summary> Constant EbsOptimized for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.GroupSet"> <summary> Constant GroupSet for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.InstanceInitiatedShutdownBehavior"> <summary> Constant InstanceInitiatedShutdownBehavior for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.InstanceType"> <summary> Constant InstanceType for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.Kernel"> <summary> Constant Kernel for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.ProductCodes"> <summary> Constant ProductCodes for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.Ramdisk"> <summary> Constant Ramdisk for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.RootDeviceName"> <summary> Constant RootDeviceName for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.SourceDestCheck"> <summary> Constant SourceDestCheck for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.SriovNetSupport"> <summary> Constant SriovNetSupport for InstanceAttributeName </summary> </member> <member name="F:Amazon.EC2.InstanceAttributeName.UserData"> <summary> Constant UserData for InstanceAttributeName </summary> </member> <member name="M:Amazon.EC2.InstanceAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.InstanceAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.InstanceLifecycleType"> <summary> Constants used for properties of type InstanceLifecycleType. </summary> </member> <member name="F:Amazon.EC2.InstanceLifecycleType.Spot"> <summary> Constant Spot for InstanceLifecycleType </summary> </member> <member name="M:Amazon.EC2.InstanceLifecycleType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.InstanceLifecycleType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.InstanceStateName"> <summary> Constants used for properties of type InstanceStateName. </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.Pending"> <summary> Constant Pending for InstanceStateName </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.Running"> <summary> Constant Running for InstanceStateName </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.ShuttingDown"> <summary> Constant ShuttingDown for InstanceStateName </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.Stopped"> <summary> Constant Stopped for InstanceStateName </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.Stopping"> <summary> Constant Stopping for InstanceStateName </summary> </member> <member name="F:Amazon.EC2.InstanceStateName.Terminated"> <summary> Constant Terminated for InstanceStateName </summary> </member> <member name="M:Amazon.EC2.InstanceStateName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.InstanceStateName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.InstanceType"> <summary> Constants used for properties of type InstanceType. </summary> </member> <member name="F:Amazon.EC2.InstanceType.C1Medium"> <summary> Constant C1Medium for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C1Xlarge"> <summary> Constant C1Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C32xlarge"> <summary> Constant C32xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C34xlarge"> <summary> Constant C34xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C38xlarge"> <summary> Constant C38xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C3Large"> <summary> Constant C3Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C3Xlarge"> <summary> Constant C3Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C42xlarge"> <summary> Constant C42xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C44xlarge"> <summary> Constant C44xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C48xlarge"> <summary> Constant C48xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C4Large"> <summary> Constant C4Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.C4Xlarge"> <summary> Constant C4Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Cc14xlarge"> <summary> Constant Cc14xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Cc28xlarge"> <summary> Constant Cc28xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Cg14xlarge"> <summary> Constant Cg14xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Cr18xlarge"> <summary> Constant Cr18xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.D22xlarge"> <summary> Constant D22xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.D24xlarge"> <summary> Constant D24xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.D28xlarge"> <summary> Constant D28xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.D2Xlarge"> <summary> Constant D2Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.G22xlarge"> <summary> Constant G22xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Hi14xlarge"> <summary> Constant Hi14xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.Hs18xlarge"> <summary> Constant Hs18xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.I22xlarge"> <summary> Constant I22xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.I24xlarge"> <summary> Constant I24xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.I28xlarge"> <summary> Constant I28xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.I2Xlarge"> <summary> Constant I2Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M1Large"> <summary> Constant M1Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M1Medium"> <summary> Constant M1Medium for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M1Small"> <summary> Constant M1Small for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M1Xlarge"> <summary> Constant M1Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M22xlarge"> <summary> Constant M22xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M24xlarge"> <summary> Constant M24xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M2Xlarge"> <summary> Constant M2Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M32xlarge"> <summary> Constant M32xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M3Large"> <summary> Constant M3Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M3Medium"> <summary> Constant M3Medium for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M3Xlarge"> <summary> Constant M3Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M410xlarge"> <summary> Constant M410xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M42xlarge"> <summary> Constant M42xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M44xlarge"> <summary> Constant M44xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M4Large"> <summary> Constant M4Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.M4Xlarge"> <summary> Constant M4Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.R32xlarge"> <summary> Constant R32xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.R34xlarge"> <summary> Constant R34xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.R38xlarge"> <summary> Constant R38xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.R3Large"> <summary> Constant R3Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.R3Xlarge"> <summary> Constant R3Xlarge for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.T1Micro"> <summary> Constant T1Micro for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.T2Large"> <summary> Constant T2Large for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.T2Medium"> <summary> Constant T2Medium for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.T2Micro"> <summary> Constant T2Micro for InstanceType </summary> </member> <member name="F:Amazon.EC2.InstanceType.T2Small"> <summary> Constant T2Small for InstanceType </summary> </member> <member name="M:Amazon.EC2.InstanceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.InstanceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ListingState"> <summary> Constants used for properties of type ListingState. </summary> </member> <member name="F:Amazon.EC2.ListingState.Available"> <summary> Constant Available for ListingState </summary> </member> <member name="F:Amazon.EC2.ListingState.Cancelled"> <summary> Constant Cancelled for ListingState </summary> </member> <member name="F:Amazon.EC2.ListingState.Pending"> <summary> Constant Pending for ListingState </summary> </member> <member name="F:Amazon.EC2.ListingState.Sold"> <summary> Constant Sold for ListingState </summary> </member> <member name="M:Amazon.EC2.ListingState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ListingState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ListingStatus"> <summary> Constants used for properties of type ListingStatus. </summary> </member> <member name="F:Amazon.EC2.ListingStatus.Active"> <summary> Constant Active for ListingStatus </summary> </member> <member name="F:Amazon.EC2.ListingStatus.Cancelled"> <summary> Constant Cancelled for ListingStatus </summary> </member> <member name="F:Amazon.EC2.ListingStatus.Closed"> <summary> Constant Closed for ListingStatus </summary> </member> <member name="F:Amazon.EC2.ListingStatus.Pending"> <summary> Constant Pending for ListingStatus </summary> </member> <member name="M:Amazon.EC2.ListingStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ListingStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.MonitoringState"> <summary> Constants used for properties of type MonitoringState. </summary> </member> <member name="F:Amazon.EC2.MonitoringState.Disabled"> <summary> Constant Disabled for MonitoringState </summary> </member> <member name="F:Amazon.EC2.MonitoringState.Disabling"> <summary> Constant Disabling for MonitoringState </summary> </member> <member name="F:Amazon.EC2.MonitoringState.Enabled"> <summary> Constant Enabled for MonitoringState </summary> </member> <member name="F:Amazon.EC2.MonitoringState.Pending"> <summary> Constant Pending for MonitoringState </summary> </member> <member name="M:Amazon.EC2.MonitoringState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.MonitoringState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.MoveStatus"> <summary> Constants used for properties of type MoveStatus. </summary> </member> <member name="F:Amazon.EC2.MoveStatus.MovingToVpc"> <summary> Constant MovingToVpc for MoveStatus </summary> </member> <member name="F:Amazon.EC2.MoveStatus.RestoringToClassic"> <summary> Constant RestoringToClassic for MoveStatus </summary> </member> <member name="M:Amazon.EC2.MoveStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.MoveStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.NetworkInterfaceAttribute"> <summary> Constants used for properties of type NetworkInterfaceAttribute. </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceAttribute.Attachment"> <summary> Constant Attachment for NetworkInterfaceAttribute </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceAttribute.Description"> <summary> Constant Description for NetworkInterfaceAttribute </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceAttribute.GroupSet"> <summary> Constant GroupSet for NetworkInterfaceAttribute </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceAttribute.SourceDestCheck"> <summary> Constant SourceDestCheck for NetworkInterfaceAttribute </summary> </member> <member name="M:Amazon.EC2.NetworkInterfaceAttribute.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.NetworkInterfaceAttribute.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.NetworkInterfaceStatus"> <summary> Constants used for properties of type NetworkInterfaceStatus. </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceStatus.Attaching"> <summary> Constant Attaching for NetworkInterfaceStatus </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceStatus.Available"> <summary> Constant Available for NetworkInterfaceStatus </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceStatus.Detaching"> <summary> Constant Detaching for NetworkInterfaceStatus </summary> </member> <member name="F:Amazon.EC2.NetworkInterfaceStatus.InUse"> <summary> Constant InUse for NetworkInterfaceStatus </summary> </member> <member name="M:Amazon.EC2.NetworkInterfaceStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.NetworkInterfaceStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.OfferingTypeValues"> <summary> Constants used for properties of type OfferingTypeValues. </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.AllUpfront"> <summary> Constant AllUpfront for OfferingTypeValues </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.HeavyUtilization"> <summary> Constant HeavyUtilization for OfferingTypeValues </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.LightUtilization"> <summary> Constant LightUtilization for OfferingTypeValues </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.MediumUtilization"> <summary> Constant MediumUtilization for OfferingTypeValues </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.NoUpfront"> <summary> Constant NoUpfront for OfferingTypeValues </summary> </member> <member name="F:Amazon.EC2.OfferingTypeValues.PartialUpfront"> <summary> Constant PartialUpfront for OfferingTypeValues </summary> </member> <member name="M:Amazon.EC2.OfferingTypeValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.OfferingTypeValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.OperationType"> <summary> Constants used for properties of type OperationType. </summary> </member> <member name="F:Amazon.EC2.OperationType.Add"> <summary> Constant Add for OperationType </summary> </member> <member name="F:Amazon.EC2.OperationType.Remove"> <summary> Constant Remove for OperationType </summary> </member> <member name="M:Amazon.EC2.OperationType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.OperationType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.PermissionGroup"> <summary> Constants used for properties of type PermissionGroup. </summary> </member> <member name="F:Amazon.EC2.PermissionGroup.All"> <summary> Constant All for PermissionGroup </summary> </member> <member name="M:Amazon.EC2.PermissionGroup.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.PermissionGroup.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.PlacementGroupState"> <summary> Constants used for properties of type PlacementGroupState. </summary> </member> <member name="F:Amazon.EC2.PlacementGroupState.Available"> <summary> Constant Available for PlacementGroupState </summary> </member> <member name="F:Amazon.EC2.PlacementGroupState.Deleted"> <summary> Constant Deleted for PlacementGroupState </summary> </member> <member name="F:Amazon.EC2.PlacementGroupState.Deleting"> <summary> Constant Deleting for PlacementGroupState </summary> </member> <member name="F:Amazon.EC2.PlacementGroupState.Pending"> <summary> Constant Pending for PlacementGroupState </summary> </member> <member name="M:Amazon.EC2.PlacementGroupState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.PlacementGroupState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.PlacementStrategy"> <summary> Constants used for properties of type PlacementStrategy. </summary> </member> <member name="F:Amazon.EC2.PlacementStrategy.Cluster"> <summary> Constant Cluster for PlacementStrategy </summary> </member> <member name="M:Amazon.EC2.PlacementStrategy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.PlacementStrategy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.PlatformValues"> <summary> Constants used for properties of type PlatformValues. </summary> </member> <member name="F:Amazon.EC2.PlatformValues.Windows"> <summary> Constant Windows for PlatformValues </summary> </member> <member name="M:Amazon.EC2.PlatformValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.PlatformValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ProductCodeValues"> <summary> Constants used for properties of type ProductCodeValues. </summary> </member> <member name="F:Amazon.EC2.ProductCodeValues.Devpay"> <summary> Constant Devpay for ProductCodeValues </summary> </member> <member name="F:Amazon.EC2.ProductCodeValues.Marketplace"> <summary> Constant Marketplace for ProductCodeValues </summary> </member> <member name="M:Amazon.EC2.ProductCodeValues.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ProductCodeValues.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.RecurringChargeFrequency"> <summary> Constants used for properties of type RecurringChargeFrequency. </summary> </member> <member name="F:Amazon.EC2.RecurringChargeFrequency.Hourly"> <summary> Constant Hourly for RecurringChargeFrequency </summary> </member> <member name="M:Amazon.EC2.RecurringChargeFrequency.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.RecurringChargeFrequency.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ReportInstanceReasonCodes"> <summary> Constants used for properties of type ReportInstanceReasonCodes. </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.InstanceStuckInState"> <summary> Constant InstanceStuckInState for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.NotAcceptingCredentials"> <summary> Constant NotAcceptingCredentials for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.Other"> <summary> Constant Other for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.PasswordNotAvailable"> <summary> Constant PasswordNotAvailable for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.PerformanceEbsVolume"> <summary> Constant PerformanceEbsVolume for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.PerformanceInstanceStore"> <summary> Constant PerformanceInstanceStore for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.PerformanceNetwork"> <summary> Constant PerformanceNetwork for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.PerformanceOther"> <summary> Constant PerformanceOther for ReportInstanceReasonCodes </summary> </member> <member name="F:Amazon.EC2.ReportInstanceReasonCodes.Unresponsive"> <summary> Constant Unresponsive for ReportInstanceReasonCodes </summary> </member> <member name="M:Amazon.EC2.ReportInstanceReasonCodes.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ReportInstanceReasonCodes.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ReportStatusType"> <summary> Constants used for properties of type ReportStatusType. </summary> </member> <member name="F:Amazon.EC2.ReportStatusType.Impaired"> <summary> Constant Impaired for ReportStatusType </summary> </member> <member name="F:Amazon.EC2.ReportStatusType.Ok"> <summary> Constant Ok for ReportStatusType </summary> </member> <member name="M:Amazon.EC2.ReportStatusType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ReportStatusType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ReservedInstanceState"> <summary> Constants used for properties of type ReservedInstanceState. </summary> </member> <member name="F:Amazon.EC2.ReservedInstanceState.Active"> <summary> Constant Active for ReservedInstanceState </summary> </member> <member name="F:Amazon.EC2.ReservedInstanceState.PaymentFailed"> <summary> Constant PaymentFailed for ReservedInstanceState </summary> </member> <member name="F:Amazon.EC2.ReservedInstanceState.PaymentPending"> <summary> Constant PaymentPending for ReservedInstanceState </summary> </member> <member name="F:Amazon.EC2.ReservedInstanceState.Retired"> <summary> Constant Retired for ReservedInstanceState </summary> </member> <member name="M:Amazon.EC2.ReservedInstanceState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ReservedInstanceState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ResetImageAttributeName"> <summary> Constants used for properties of type ResetImageAttributeName. </summary> </member> <member name="F:Amazon.EC2.ResetImageAttributeName.LaunchPermission"> <summary> Constant LaunchPermission for ResetImageAttributeName </summary> </member> <member name="M:Amazon.EC2.ResetImageAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ResetImageAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ResourceType"> <summary> Constants used for properties of type ResourceType. </summary> </member> <member name="F:Amazon.EC2.ResourceType.CustomerGateway"> <summary> Constant CustomerGateway for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.DhcpOptions"> <summary> Constant DhcpOptions for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Image"> <summary> Constant Image for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Instance"> <summary> Constant Instance for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.InternetGateway"> <summary> Constant InternetGateway for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.NetworkAcl"> <summary> Constant NetworkAcl for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.NetworkInterface"> <summary> Constant NetworkInterface for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.ReservedInstances"> <summary> Constant ReservedInstances for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.RouteTable"> <summary> Constant RouteTable for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.SecurityGroup"> <summary> Constant SecurityGroup for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Snapshot"> <summary> Constant Snapshot for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.SpotInstancesRequest"> <summary> Constant SpotInstancesRequest for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Subnet"> <summary> Constant Subnet for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Volume"> <summary> Constant Volume for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.Vpc"> <summary> Constant Vpc for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.VpnConnection"> <summary> Constant VpnConnection for ResourceType </summary> </member> <member name="F:Amazon.EC2.ResourceType.VpnGateway"> <summary> Constant VpnGateway for ResourceType </summary> </member> <member name="M:Amazon.EC2.ResourceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ResourceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.RIProductDescription"> <summary> Constants used for properties of type RIProductDescription. </summary> </member> <member name="F:Amazon.EC2.RIProductDescription.LinuxUNIX"> <summary> Constant LinuxUNIX for RIProductDescription </summary> </member> <member name="F:Amazon.EC2.RIProductDescription.LinuxUNIXAmazonVPC"> <summary> Constant LinuxUNIXAmazonVPC for RIProductDescription </summary> </member> <member name="F:Amazon.EC2.RIProductDescription.Windows"> <summary> Constant Windows for RIProductDescription </summary> </member> <member name="F:Amazon.EC2.RIProductDescription.WindowsAmazonVPC"> <summary> Constant WindowsAmazonVPC for RIProductDescription </summary> </member> <member name="M:Amazon.EC2.RIProductDescription.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.RIProductDescription.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.RouteOrigin"> <summary> Constants used for properties of type RouteOrigin. </summary> </member> <member name="F:Amazon.EC2.RouteOrigin.CreateRoute"> <summary> Constant CreateRoute for RouteOrigin </summary> </member> <member name="F:Amazon.EC2.RouteOrigin.CreateRouteTable"> <summary> Constant CreateRouteTable for RouteOrigin </summary> </member> <member name="F:Amazon.EC2.RouteOrigin.EnableVgwRoutePropagation"> <summary> Constant EnableVgwRoutePropagation for RouteOrigin </summary> </member> <member name="M:Amazon.EC2.RouteOrigin.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.RouteOrigin.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.RouteState"> <summary> Constants used for properties of type RouteState. </summary> </member> <member name="F:Amazon.EC2.RouteState.Active"> <summary> Constant Active for RouteState </summary> </member> <member name="F:Amazon.EC2.RouteState.Blackhole"> <summary> Constant Blackhole for RouteState </summary> </member> <member name="M:Amazon.EC2.RouteState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.RouteState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.RuleAction"> <summary> Constants used for properties of type RuleAction. </summary> </member> <member name="F:Amazon.EC2.RuleAction.Allow"> <summary> Constant Allow for RuleAction </summary> </member> <member name="F:Amazon.EC2.RuleAction.Deny"> <summary> Constant Deny for RuleAction </summary> </member> <member name="M:Amazon.EC2.RuleAction.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.RuleAction.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.ShutdownBehavior"> <summary> Constants used for properties of type ShutdownBehavior. </summary> </member> <member name="F:Amazon.EC2.ShutdownBehavior.Stop"> <summary> Constant Stop for ShutdownBehavior </summary> </member> <member name="F:Amazon.EC2.ShutdownBehavior.Terminate"> <summary> Constant Terminate for ShutdownBehavior </summary> </member> <member name="M:Amazon.EC2.ShutdownBehavior.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.ShutdownBehavior.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SnapshotAttributeName"> <summary> Constants used for properties of type SnapshotAttributeName. </summary> </member> <member name="F:Amazon.EC2.SnapshotAttributeName.CreateVolumePermission"> <summary> Constant CreateVolumePermission for SnapshotAttributeName </summary> </member> <member name="F:Amazon.EC2.SnapshotAttributeName.ProductCodes"> <summary> Constant ProductCodes for SnapshotAttributeName </summary> </member> <member name="M:Amazon.EC2.SnapshotAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SnapshotAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SnapshotState"> <summary> Constants used for properties of type SnapshotState. </summary> </member> <member name="F:Amazon.EC2.SnapshotState.Completed"> <summary> Constant Completed for SnapshotState </summary> </member> <member name="F:Amazon.EC2.SnapshotState.Error"> <summary> Constant Error for SnapshotState </summary> </member> <member name="F:Amazon.EC2.SnapshotState.Pending"> <summary> Constant Pending for SnapshotState </summary> </member> <member name="M:Amazon.EC2.SnapshotState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SnapshotState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SpotInstanceState"> <summary> Constants used for properties of type SpotInstanceState. </summary> </member> <member name="F:Amazon.EC2.SpotInstanceState.Active"> <summary> Constant Active for SpotInstanceState </summary> </member> <member name="F:Amazon.EC2.SpotInstanceState.Cancelled"> <summary> Constant Cancelled for SpotInstanceState </summary> </member> <member name="F:Amazon.EC2.SpotInstanceState.Closed"> <summary> Constant Closed for SpotInstanceState </summary> </member> <member name="F:Amazon.EC2.SpotInstanceState.Failed"> <summary> Constant Failed for SpotInstanceState </summary> </member> <member name="F:Amazon.EC2.SpotInstanceState.Open"> <summary> Constant Open for SpotInstanceState </summary> </member> <member name="M:Amazon.EC2.SpotInstanceState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SpotInstanceState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SpotInstanceType"> <summary> Constants used for properties of type SpotInstanceType. </summary> </member> <member name="F:Amazon.EC2.SpotInstanceType.OneTime"> <summary> Constant OneTime for SpotInstanceType </summary> </member> <member name="F:Amazon.EC2.SpotInstanceType.Persistent"> <summary> Constant Persistent for SpotInstanceType </summary> </member> <member name="M:Amazon.EC2.SpotInstanceType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SpotInstanceType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.State"> <summary> Constants used for properties of type State. </summary> </member> <member name="F:Amazon.EC2.State.Available"> <summary> Constant Available for State </summary> </member> <member name="F:Amazon.EC2.State.Deleted"> <summary> Constant Deleted for State </summary> </member> <member name="F:Amazon.EC2.State.Deleting"> <summary> Constant Deleting for State </summary> </member> <member name="F:Amazon.EC2.State.Pending"> <summary> Constant Pending for State </summary> </member> <member name="M:Amazon.EC2.State.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.State.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.Status"> <summary> Constants used for properties of type Status. </summary> </member> <member name="F:Amazon.EC2.Status.InClassic"> <summary> Constant InClassic for Status </summary> </member> <member name="F:Amazon.EC2.Status.InVpc"> <summary> Constant InVpc for Status </summary> </member> <member name="F:Amazon.EC2.Status.MoveInProgress"> <summary> Constant MoveInProgress for Status </summary> </member> <member name="M:Amazon.EC2.Status.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.Status.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.StatusName"> <summary> Constants used for properties of type StatusName. </summary> </member> <member name="F:Amazon.EC2.StatusName.Reachability"> <summary> Constant Reachability for StatusName </summary> </member> <member name="M:Amazon.EC2.StatusName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.StatusName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.StatusType"> <summary> Constants used for properties of type StatusType. </summary> </member> <member name="F:Amazon.EC2.StatusType.Failed"> <summary> Constant Failed for StatusType </summary> </member> <member name="F:Amazon.EC2.StatusType.Initializing"> <summary> Constant Initializing for StatusType </summary> </member> <member name="F:Amazon.EC2.StatusType.InsufficientData"> <summary> Constant InsufficientData for StatusType </summary> </member> <member name="F:Amazon.EC2.StatusType.Passed"> <summary> Constant Passed for StatusType </summary> </member> <member name="M:Amazon.EC2.StatusType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.StatusType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SubnetState"> <summary> Constants used for properties of type SubnetState. </summary> </member> <member name="F:Amazon.EC2.SubnetState.Available"> <summary> Constant Available for SubnetState </summary> </member> <member name="F:Amazon.EC2.SubnetState.Pending"> <summary> Constant Pending for SubnetState </summary> </member> <member name="M:Amazon.EC2.SubnetState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SubnetState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.SummaryStatus"> <summary> Constants used for properties of type SummaryStatus. </summary> </member> <member name="F:Amazon.EC2.SummaryStatus.Impaired"> <summary> Constant Impaired for SummaryStatus </summary> </member> <member name="F:Amazon.EC2.SummaryStatus.Initializing"> <summary> Constant Initializing for SummaryStatus </summary> </member> <member name="F:Amazon.EC2.SummaryStatus.InsufficientData"> <summary> Constant InsufficientData for SummaryStatus </summary> </member> <member name="F:Amazon.EC2.SummaryStatus.NotApplicable"> <summary> Constant NotApplicable for SummaryStatus </summary> </member> <member name="F:Amazon.EC2.SummaryStatus.Ok"> <summary> Constant Ok for SummaryStatus </summary> </member> <member name="M:Amazon.EC2.SummaryStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.SummaryStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.TelemetryStatus"> <summary> Constants used for properties of type TelemetryStatus. </summary> </member> <member name="F:Amazon.EC2.TelemetryStatus.DOWN"> <summary> Constant DOWN for TelemetryStatus </summary> </member> <member name="F:Amazon.EC2.TelemetryStatus.UP"> <summary> Constant UP for TelemetryStatus </summary> </member> <member name="M:Amazon.EC2.TelemetryStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.TelemetryStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.Tenancy"> <summary> Constants used for properties of type Tenancy. </summary> </member> <member name="F:Amazon.EC2.Tenancy.Dedicated"> <summary> Constant Dedicated for Tenancy </summary> </member> <member name="F:Amazon.EC2.Tenancy.Default"> <summary> Constant Default for Tenancy </summary> </member> <member name="M:Amazon.EC2.Tenancy.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.Tenancy.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.TrafficType"> <summary> Constants used for properties of type TrafficType. </summary> </member> <member name="F:Amazon.EC2.TrafficType.ACCEPT"> <summary> Constant ACCEPT for TrafficType </summary> </member> <member name="F:Amazon.EC2.TrafficType.ALL"> <summary> Constant ALL for TrafficType </summary> </member> <member name="F:Amazon.EC2.TrafficType.REJECT"> <summary> Constant REJECT for TrafficType </summary> </member> <member name="M:Amazon.EC2.TrafficType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.TrafficType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VirtualizationType"> <summary> Constants used for properties of type VirtualizationType. </summary> </member> <member name="F:Amazon.EC2.VirtualizationType.Hvm"> <summary> Constant Hvm for VirtualizationType </summary> </member> <member name="F:Amazon.EC2.VirtualizationType.Paravirtual"> <summary> Constant Paravirtual for VirtualizationType </summary> </member> <member name="M:Amazon.EC2.VirtualizationType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VirtualizationType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeAttachmentState"> <summary> Constants used for properties of type VolumeAttachmentState. </summary> </member> <member name="F:Amazon.EC2.VolumeAttachmentState.Attached"> <summary> Constant Attached for VolumeAttachmentState </summary> </member> <member name="F:Amazon.EC2.VolumeAttachmentState.Attaching"> <summary> Constant Attaching for VolumeAttachmentState </summary> </member> <member name="F:Amazon.EC2.VolumeAttachmentState.Detached"> <summary> Constant Detached for VolumeAttachmentState </summary> </member> <member name="F:Amazon.EC2.VolumeAttachmentState.Detaching"> <summary> Constant Detaching for VolumeAttachmentState </summary> </member> <member name="M:Amazon.EC2.VolumeAttachmentState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeAttachmentState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeAttributeName"> <summary> Constants used for properties of type VolumeAttributeName. </summary> </member> <member name="F:Amazon.EC2.VolumeAttributeName.AutoEnableIO"> <summary> Constant AutoEnableIO for VolumeAttributeName </summary> </member> <member name="F:Amazon.EC2.VolumeAttributeName.ProductCodes"> <summary> Constant ProductCodes for VolumeAttributeName </summary> </member> <member name="M:Amazon.EC2.VolumeAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeState"> <summary> Constants used for properties of type VolumeState. </summary> </member> <member name="F:Amazon.EC2.VolumeState.Available"> <summary> Constant Available for VolumeState </summary> </member> <member name="F:Amazon.EC2.VolumeState.Creating"> <summary> Constant Creating for VolumeState </summary> </member> <member name="F:Amazon.EC2.VolumeState.Deleted"> <summary> Constant Deleted for VolumeState </summary> </member> <member name="F:Amazon.EC2.VolumeState.Deleting"> <summary> Constant Deleting for VolumeState </summary> </member> <member name="F:Amazon.EC2.VolumeState.Error"> <summary> Constant Error for VolumeState </summary> </member> <member name="F:Amazon.EC2.VolumeState.InUse"> <summary> Constant InUse for VolumeState </summary> </member> <member name="M:Amazon.EC2.VolumeState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeStatusInfoStatus"> <summary> Constants used for properties of type VolumeStatusInfoStatus. </summary> </member> <member name="F:Amazon.EC2.VolumeStatusInfoStatus.Impaired"> <summary> Constant Impaired for VolumeStatusInfoStatus </summary> </member> <member name="F:Amazon.EC2.VolumeStatusInfoStatus.InsufficientData"> <summary> Constant InsufficientData for VolumeStatusInfoStatus </summary> </member> <member name="F:Amazon.EC2.VolumeStatusInfoStatus.Ok"> <summary> Constant Ok for VolumeStatusInfoStatus </summary> </member> <member name="M:Amazon.EC2.VolumeStatusInfoStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeStatusInfoStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeStatusName"> <summary> Constants used for properties of type VolumeStatusName. </summary> </member> <member name="F:Amazon.EC2.VolumeStatusName.IoEnabled"> <summary> Constant IoEnabled for VolumeStatusName </summary> </member> <member name="F:Amazon.EC2.VolumeStatusName.IoPerformance"> <summary> Constant IoPerformance for VolumeStatusName </summary> </member> <member name="M:Amazon.EC2.VolumeStatusName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeStatusName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VolumeType"> <summary> Constants used for properties of type VolumeType. </summary> </member> <member name="F:Amazon.EC2.VolumeType.Gp2"> <summary> Constant Gp2 for VolumeType </summary> </member> <member name="F:Amazon.EC2.VolumeType.Io1"> <summary> Constant Io1 for VolumeType </summary> </member> <member name="F:Amazon.EC2.VolumeType.Standard"> <summary> Constant Standard for VolumeType </summary> </member> <member name="M:Amazon.EC2.VolumeType.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VolumeType.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VpcAttributeName"> <summary> Constants used for properties of type VpcAttributeName. </summary> </member> <member name="F:Amazon.EC2.VpcAttributeName.EnableDnsHostnames"> <summary> Constant EnableDnsHostnames for VpcAttributeName </summary> </member> <member name="F:Amazon.EC2.VpcAttributeName.EnableDnsSupport"> <summary> Constant EnableDnsSupport for VpcAttributeName </summary> </member> <member name="M:Amazon.EC2.VpcAttributeName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VpcAttributeName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VpcPeeringConnectionStateReasonCode"> <summary> Constants used for properties of type VpcPeeringConnectionStateReasonCode. </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Active"> <summary> Constant Active for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Deleted"> <summary> Constant Deleted for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Deleting"> <summary> Constant Deleting for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Expired"> <summary> Constant Expired for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Failed"> <summary> Constant Failed for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.InitiatingRequest"> <summary> Constant InitiatingRequest for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.PendingAcceptance"> <summary> Constant PendingAcceptance for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Provisioning"> <summary> Constant Provisioning for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="F:Amazon.EC2.VpcPeeringConnectionStateReasonCode.Rejected"> <summary> Constant Rejected for VpcPeeringConnectionStateReasonCode </summary> </member> <member name="M:Amazon.EC2.VpcPeeringConnectionStateReasonCode.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VpcPeeringConnectionStateReasonCode.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VpcState"> <summary> Constants used for properties of type VpcState. </summary> </member> <member name="F:Amazon.EC2.VpcState.Available"> <summary> Constant Available for VpcState </summary> </member> <member name="F:Amazon.EC2.VpcState.Pending"> <summary> Constant Pending for VpcState </summary> </member> <member name="M:Amazon.EC2.VpcState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VpcState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VpnState"> <summary> Constants used for properties of type VpnState. </summary> </member> <member name="F:Amazon.EC2.VpnState.Available"> <summary> Constant Available for VpnState </summary> </member> <member name="F:Amazon.EC2.VpnState.Deleted"> <summary> Constant Deleted for VpnState </summary> </member> <member name="F:Amazon.EC2.VpnState.Deleting"> <summary> Constant Deleting for VpnState </summary> </member> <member name="F:Amazon.EC2.VpnState.Pending"> <summary> Constant Pending for VpnState </summary> </member> <member name="M:Amazon.EC2.VpnState.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VpnState.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.VpnStaticRouteSource"> <summary> Constants used for properties of type VpnStaticRouteSource. </summary> </member> <member name="F:Amazon.EC2.VpnStaticRouteSource.Static"> <summary> Constant Static for VpnStaticRouteSource </summary> </member> <member name="M:Amazon.EC2.VpnStaticRouteSource.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.EC2.VpnStaticRouteSource.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest"> <summary> Container for the parameters to the AcceptVpcPeeringConnection operation. Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to view your outstanding VPC peering connection requests. </summary> </member> <member name="T:Amazon.EC2.AmazonEC2Request"> <summary> Base class for EC2 operation requests. </summary> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of the VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse"> <summary> Configuration for accessing Amazon AcceptVpcPeeringConnection service </summary> </member> <member name="T:Amazon.EC2.Model.AcceptVpcPeeringConnectionResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionResult.VpcPeeringConnection"> <summary> Gets and sets the property VpcPeeringConnection. <para> Information about the VPC peering connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AcceptVpcPeeringConnectionResponse.AcceptVpcPeeringConnectionResult"> <summary> Gets and sets the AcceptVpcPeeringConnectionResult property. Represents the output of a AcceptVpcPeeringConnection operation. </summary> </member> <member name="T:Amazon.EC2.Model.AccountAttribute"> <summary> Describes an account attribute. </summary> </member> <member name="P:Amazon.EC2.Model.AccountAttribute.AttributeName"> <summary> Gets and sets the property AttributeName. <para> The name of the account attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AccountAttribute.AttributeValues"> <summary> Gets and sets the property AttributeValues. <para> One or more values for the account attribute. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AccountAttributeValue"> <summary> Describes a value of an account attribute. </summary> </member> <member name="P:Amazon.EC2.Model.AccountAttributeValue.AttributeValue"> <summary> Gets and sets the property AttributeValue. <para> The value of the attribute. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ActiveInstance"> <summary> Describes a running instance in a Spot fleet. </summary> </member> <member name="P:Amazon.EC2.Model.ActiveInstance.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ActiveInstance.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ActiveInstance.SpotInstanceRequestId"> <summary> Gets and sets the property SpotInstanceRequestId. <para> The ID of the Spot instance request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Address"> <summary> Describes an Elastic IP address. </summary> </member> <member name="P:Amazon.EC2.Model.Address.AllocationId"> <summary> Gets and sets the property AllocationId. <para> The ID representing the allocation of the address for use with EC2-VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The ID representing the association of the address with an instance in a VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.Domain"> <summary> Gets and sets the property Domain. <para> Indicates whether this Elastic IP address is for use with instances in EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance that the address is associated with (if any). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.NetworkInterfaceOwnerId"> <summary> Gets and sets the property NetworkInterfaceOwnerId. <para> The ID of the AWS account that owns the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address associated with the Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Address.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressRequest"> <summary> Container for the parameters to the AllocateAddress operation. Acquires an Elastic IP address. <para> An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressRequest.Domain"> <summary> Gets and sets the property Domain. <para> Set to <code>vpc</code> to allocate the address for use with instances in a VPC. </para> <para> Default: The address is for use with instances in EC2-Classic. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressResponse"> <summary> Configuration for accessing Amazon AllocateAddress service </summary> </member> <member name="T:Amazon.EC2.Model.AllocateAddressResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.AllocationId"> <summary> Gets and sets the property AllocationId. <para> [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.Domain"> <summary> Gets and sets the property Domain. <para> Indicates whether this Elastic IP address is for use with instances in EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResult.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AllocateAddressResponse.AllocateAddressResult"> <summary> Gets and sets the AllocateAddressResult property. Represents the output of a AllocateAddress operation. </summary> </member> <member name="T:Amazon.EC2.Model.AssignPrivateIpAddressesRequest"> <summary> Container for the parameters to the AssignPrivateIpAddresses operation. Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP addresses, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> AssignPrivateIpAddresses is available only in EC2-VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.AllowReassignment"> <summary> Gets and sets the property AllowReassignment. <para> Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses. </para> <para> If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssignPrivateIpAddressesRequest.SecondaryPrivateIpAddressCount"> <summary> Gets and sets the property SecondaryPrivateIpAddressCount. <para> The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressRequest"> <summary> Container for the parameters to the AssociateAddress operation. Associates an Elastic IP address with an instance or a network interface. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. </para> <para> [VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.AssociateAddressRequest.#ctor(System.String,System.String)"> <summary> Instantiates AssociateAddressRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. </param> <param name="publicIp">The Elastic IP address. This is required for EC2-Classic.</param> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.AllocationId"> <summary> Gets and sets the property AllocationId. <para> [EC2-VPC] The allocation ID. This is required for EC2-VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.AllowReassociation"> <summary> Gets and sets the property AllowReassociation. <para> [EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. This is required for EC2-Classic. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressResponse"> <summary> Configuration for accessing Amazon AssociateAddress service </summary> </member> <member name="T:Amazon.EC2.Model.AssociateAddressResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressResult.AssociationId"> <summary> Gets and sets the property AssociationId. <para> [EC2-VPC] The ID that represents the association of the Elastic IP address with an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateAddressResponse.AssociateAddressResult"> <summary> Gets and sets the AssociateAddressResult property. Represents the output of a AssociateAddress operation. </summary> </member> <member name="T:Amazon.EC2.Model.AssociateDhcpOptionsRequest"> <summary> Container for the parameters to the AssociateDhcpOptions operation. Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. <para> After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.AssociateDhcpOptionsRequest.#ctor(System.String)"> <summary> Instantiates AssociateDhcpOptionsRequest with the parameterized properties </summary> <param name="vpcId">The ID of the VPC.</param> </member> <member name="P:Amazon.EC2.Model.AssociateDhcpOptionsRequest.DhcpOptionsId"> <summary> Gets and sets the property DhcpOptionsId. <para> The ID of the DHCP options set, or <code>default</code> to associate no DHCP options with the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateDhcpOptionsRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableRequest"> <summary> Container for the parameters to the AssociateRouteTable operation. Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableResponse"> <summary> Configuration for accessing Amazon AssociateRouteTable service </summary> </member> <member name="T:Amazon.EC2.Model.AssociateRouteTableResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableResult.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The route table association ID (needed to disassociate the route table). </para> </summary> </member> <member name="P:Amazon.EC2.Model.AssociateRouteTableResponse.AssociateRouteTableResult"> <summary> Gets and sets the AssociateRouteTableResult property. Represents the output of a AssociateRouteTable operation. </summary> </member> <member name="T:Amazon.EC2.Model.AttachClassicLinkVpcRequest"> <summary> Container for the parameters to the AttachClassicLinkVpc operation. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the <code>running</code> state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. <para> After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. </para> <para> Linking your instance to a VPC is sometimes referred to as <i>attaching</i> your instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachClassicLinkVpcRequest.Groups"> <summary> Gets and sets the property Groups. <para> The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachClassicLinkVpcRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachClassicLinkVpcRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of a ClassicLink-enabled VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AttachClassicLinkVpcResponse"> <summary> Configuration for accessing Amazon AttachClassicLinkVpc service </summary> </member> <member name="T:Amazon.EC2.Model.AttachClassicLinkVpcResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AttachClassicLinkVpcResult.Return"> <summary> Gets and sets the property Return. <para> Returns <code>true</code> if the request succeeds; otherwise, it returns an error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachClassicLinkVpcResponse.AttachClassicLinkVpcResult"> <summary> Gets and sets the AttachClassicLinkVpcResult property. Represents the output of a AttachClassicLinkVpc operation. </summary> </member> <member name="T:Amazon.EC2.Model.AttachInternetGatewayRequest"> <summary> Container for the parameters to the AttachInternetGateway operation. Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </summary> </member> <member name="P:Amazon.EC2.Model.AttachInternetGatewayRequest.InternetGatewayId"> <summary> Gets and sets the property InternetGatewayId. <para> The ID of the Internet gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachInternetGatewayRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AttachNetworkInterfaceRequest"> <summary> Container for the parameters to the AttachNetworkInterface operation. Attaches a network interface to an instance. </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.DeviceIndex"> <summary> Gets and sets the property DeviceIndex. <para> The index of the device for the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AttachNetworkInterfaceResponse"> <summary> Configuration for accessing Amazon AttachNetworkInterface service </summary> </member> <member name="T:Amazon.EC2.Model.AttachNetworkInterfaceResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceResult.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachNetworkInterfaceResponse.AttachNetworkInterfaceResult"> <summary> Gets and sets the AttachNetworkInterfaceResult property. Represents the output of a AttachNetworkInterface operation. </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeRequest"> <summary> Container for the parameters to the AttachVolume operation. Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. <para> Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For a list of supported device names, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching an EBS Volume to an Instance</a>. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html">Amazon EC2 Instance Store</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If a volume has an AWS Marketplace product code: </para> <ul> <li>The volume can be attached only to a stopped instance.</li> <li>AWS Marketplace product codes are copied from the volume to the instance.</li> <li>You must be subscribed to the product.</li> <li>The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.</li> </ul> <para> For an overview of the AWS Marketplace, see <a href="https://aws.amazon.com/marketplace/help/200900000">Introducing AWS Marketplace</a>. </para> <para> For more information about EBS volumes, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html">Attaching Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.AttachVolumeRequest.#ctor(System.String,System.String,System.String)"> <summary> Instantiates AttachVolumeRequest with the parameterized properties </summary> <param name="volumeId">The ID of the EBS volume. The volume and instance must be within the same Availability Zone.</param> <param name="instanceId">The ID of the instance.</param> <param name="device">The device name to expose to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</param> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.Device"> <summary> Gets and sets the property Device. <para> The device name to expose to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the EBS volume. The volume and instance must be within the same Availability Zone. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeResponse"> <summary> Configuration for accessing Amazon AttachVolume service </summary> </member> <member name="T:Amazon.EC2.Model.AttachVolumeResult"> <summary> Contains the response data from the AttachVolume operation. </summary> </member> <member name="P:Amazon.EC2.Model.AttachVolumeResponse.AttachVolumeResult"> <summary> Gets and sets the AttachVolumeResult property. Represents the output of a AttachVolume operation. </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayRequest"> <summary> Container for the parameters to the AttachVpnGateway operation. Attaches a virtual private gateway to a VPC. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.AttachVpnGatewayRequest.#ctor(System.String,System.String)"> <summary> Instantiates AttachVpnGatewayRequest with the parameterized properties </summary> <param name="vpnGatewayId">The ID of the virtual private gateway.</param> <param name="vpcId">The ID of the VPC.</param> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayRequest.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayResponse"> <summary> Configuration for accessing Amazon AttachVpnGateway service </summary> </member> <member name="T:Amazon.EC2.Model.AttachVpnGatewayResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayResult.VpcAttachment"> <summary> Gets and sets the property VpcAttachment. <para> Information about the attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AttachVpnGatewayResponse.AttachVpnGatewayResult"> <summary> Gets and sets the AttachVpnGatewayResult property. Represents the output of a AttachVpnGateway operation. </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest"> <summary> Container for the parameters to the AuthorizeSecurityGroupEgress operation. Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. <important> <para> You can have up to 50 rules per security group (covering both ingress and egress rules). </para> </important> <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes. </para> <para> Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupEgressRequest.IpPermissions"> <summary> Gets and sets the property IpPermissions. <para> A set of IP permissions. You can't specify a destination security group and a CIDR IP address range. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest"> <summary> Container for the parameters to the AuthorizeSecurityGroupIngress operation. Adds one or more ingress rules to a security group. <important> <para> EC2-Classic: You can have up to 100 rules per group. </para> <para> EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules). </para> </important> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> <para> [EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the <i>source groups</i>) permission to access a security group for your account. A source group can be for your own AWS account, or another. </para> <para> [EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the <i>source groups</i>) permission to access a security group for your VPC. The security groups must all be for the same VPC. </para> </summary> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.EC2.Model.IpPermission})"> <summary> Instantiates AuthorizeSecurityGroupIngressRequest with the parameterized properties </summary> <param name="groupName">[EC2-Classic, default VPC] The name of the security group.</param> <param name="ipPermissions">A set of IP permissions. Can be used to specify multiple rules in a single command. </param> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. Required for a nondefault VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> [EC2-Classic, default VPC] The name of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AuthorizeSecurityGroupIngressRequest.IpPermissions"> <summary> Gets and sets the property IpPermissions. <para> A set of IP permissions. Can be used to specify multiple rules in a single command. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AvailabilityZone"> <summary> Describes an Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.Messages"> <summary> Gets and sets the property Messages. <para> Any messages about the Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.RegionName"> <summary> Gets and sets the property RegionName. <para> The name of the region. </para> </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.State"> <summary> Gets and sets the property State. <para> The state of the Availability Zone (<code>available</code> | <code>impaired</code> | <code>unavailable</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZone.ZoneName"> <summary> Gets and sets the property ZoneName. <para> The name of the Availability Zone. </para> </summary> </member> <member name="T:Amazon.EC2.Model.AvailabilityZoneMessage"> <summary> Describes a message about an Availability Zone. </summary> </member> <member name="P:Amazon.EC2.Model.AvailabilityZoneMessage.Message"> <summary> Gets and sets the property Message. <para> The message about the Availability Zone. </para> </summary> </member> <member name="T:Amazon.EC2.Model.BlockDeviceMapping"> <summary> Describes a block device mapping. </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The device name exposed to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.Ebs"> <summary> Gets and sets the property Ebs. <para> Parameters used to automatically set up EBS volumes when the instance is launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.NoDevice"> <summary> Gets and sets the property NoDevice. <para> Suppresses the specified device included in the block device mapping of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BlockDeviceMapping.VirtualName"> <summary> Gets and sets the property VirtualName. <para> The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. </para> <para> Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceRequest"> <summary> Container for the parameters to the BundleInstance operation. Bundles an Amazon instance store-backed Windows instance. <para> During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved. </para> <note> <para> This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html">Creating an Instance Store-Backed Windows AMI</a>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.BundleInstanceRequest.#ctor(System.String,Amazon.EC2.Model.Storage)"> <summary> Instantiates BundleInstanceRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance to bundle. Type: String Default: None Required: Yes</param> <param name="storage">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> </member> <member name="P:Amazon.EC2.Model.BundleInstanceRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance to bundle. </para> <para> Type: String </para> <para> Default: None </para> <para> Required: Yes </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleInstanceRequest.Storage"> <summary> Gets and sets the property Storage. <para> 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. </para> </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceResponse"> <summary> Configuration for accessing Amazon BundleInstance service </summary> </member> <member name="T:Amazon.EC2.Model.BundleInstanceResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.BundleInstanceResult.BundleTask"> <summary> Gets and sets the property BundleTask. <para> Information about the bundle task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleInstanceResponse.BundleInstanceResult"> <summary> Gets and sets the BundleInstanceResult property. Represents the output of a BundleInstance operation. </summary> </member> <member name="T:Amazon.EC2.Model.BundleTask"> <summary> Describes a bundle task. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.BundleId"> <summary> Gets and sets the property BundleId. <para> The ID of the bundle task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.BundleTaskError"> <summary> Gets and sets the property BundleTaskError. <para> If the task fails, a description of the error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance associated with this bundle task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.Progress"> <summary> Gets and sets the property Progress. <para> The level of task completion, as a percent (for example, 20%). </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.StartTime"> <summary> Gets and sets the property StartTime. <para> The time this task started. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.State"> <summary> Gets and sets the property State. <para> The state of the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.Storage"> <summary> Gets and sets the property Storage. <para> The Amazon S3 storage locations. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTask.UpdateTime"> <summary> Gets and sets the property UpdateTime. <para> The time of the most recent update for the task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.BundleTaskError"> <summary> Describes an error for <a>BundleInstance</a>. </summary> </member> <member name="P:Amazon.EC2.Model.BundleTaskError.Code"> <summary> Gets and sets the property Code. <para> The error code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.BundleTaskError.Message"> <summary> Gets and sets the property Message. <para> The error message. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskRequest"> <summary> Container for the parameters to the CancelBundleTask operation. Cancels a bundling operation for an instance store-backed Windows instance. </summary> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CancelBundleTaskRequest.#ctor(System.String)"> <summary> Instantiates CancelBundleTaskRequest with the parameterized properties </summary> <param name="bundleId">The ID of the bundle task.</param> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskRequest.BundleId"> <summary> Gets and sets the property BundleId. <para> The ID of the bundle task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskResponse"> <summary> Configuration for accessing Amazon CancelBundleTask service </summary> </member> <member name="T:Amazon.EC2.Model.CancelBundleTaskResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskResult.BundleTask"> <summary> Gets and sets the property BundleTask. <para> Information about the bundle task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelBundleTaskResponse.CancelBundleTaskResult"> <summary> Gets and sets the CancelBundleTaskResult property. Represents the output of a CancelBundleTask operation. </summary> </member> <member name="T:Amazon.EC2.Model.CancelConversionTaskRequest"> <summary> Container for the parameters to the CancelConversionTask operation. Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelConversionTaskRequest.ConversionTaskId"> <summary> Gets and sets the property ConversionTaskId. <para> The ID of the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelConversionTaskRequest.ReasonMessage"> <summary> Gets and sets the property ReasonMessage. <para> The reason for canceling the conversion task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelExportTaskRequest"> <summary> Container for the parameters to the CancelExportTask operation. Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. </summary> </member> <member name="P:Amazon.EC2.Model.CancelExportTaskRequest.ExportTaskId"> <summary> Gets and sets the property ExportTaskId. <para> The ID of the export task. This is the ID returned by <code>CreateInstanceExportTask</code>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelImportTaskRequest"> <summary> Container for the parameters to the CancelImportTask operation. Cancels an in-process import virtual machine or import snapshot task. </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskRequest.CancelReason"> <summary> Gets and sets the property CancelReason. <para> The reason for canceling the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskRequest.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The ID of the import image or import snapshot task to be canceled. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelImportTaskResponse"> <summary> Configuration for accessing Amazon CancelImportTask service </summary> </member> <member name="T:Amazon.EC2.Model.CancelImportTaskResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskResult.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The ID of the task being canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskResult.PreviousState"> <summary> Gets and sets the property PreviousState. <para> The current state of the task being canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskResult.State"> <summary> Gets and sets the property State. <para> The current state of the task being canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelImportTaskResponse.CancelImportTaskResult"> <summary> Gets and sets the CancelImportTaskResult property. Represents the output of a CancelImportTask operation. </summary> </member> <member name="T:Amazon.EC2.Model.CancelledSpotInstanceRequest"> <summary> Describes a request to cancel a Spot instance. </summary> </member> <member name="P:Amazon.EC2.Model.CancelledSpotInstanceRequest.SpotInstanceRequestId"> <summary> Gets and sets the property SpotInstanceRequestId. <para> The ID of the Spot instance request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelledSpotInstanceRequest.State"> <summary> Gets and sets the property State. <para> The state of the Spot instance request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingRequest"> <summary> Container for the parameters to the CancelReservedInstancesListing operation. Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingRequest.ReservedInstancesListingId"> <summary> Gets and sets the property ReservedInstancesListingId. <para> The ID of the Reserved Instance listing. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingResponse"> <summary> Configuration for accessing Amazon CancelReservedInstancesListing service </summary> </member> <member name="T:Amazon.EC2.Model.CancelReservedInstancesListingResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingResult.ReservedInstancesListings"> <summary> Gets and sets the property ReservedInstancesListings. <para> The Reserved Instance listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelReservedInstancesListingResponse.CancelReservedInstancesListingResult"> <summary> Gets and sets the CancelReservedInstancesListingResult property. Represents the output of a CancelReservedInstancesListing operation. </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsError"> <summary> Describes a Spot fleet error. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsError.Code"> <summary> Gets and sets the property Code. <para> The error code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsError.Message"> <summary> Gets and sets the property Message. <para> The description for the error code. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsErrorItem"> <summary> Describes a Spot fleet request that was not successfully canceled. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsErrorItem.Error"> <summary> Gets and sets the property Error. <para> The error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsErrorItem.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsRequest"> <summary> Container for the parameters to the CancelSpotFleetRequests operation. Cancels the specified Spot fleet requests. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsRequest.SpotFleetRequestIds"> <summary> Gets and sets the property SpotFleetRequestIds. <para> The IDs of the Spot fleet requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsRequest.TerminateInstances"> <summary> Gets and sets the property TerminateInstances. <para> Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsResponse"> <summary> Configuration for accessing Amazon CancelSpotFleetRequests service </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsResult"> <summary> Contains the output of CancelSpotFleetRequests. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsResult.SuccessfulFleetRequests"> <summary> Gets and sets the property SuccessfulFleetRequests. <para> Information about the Spot fleet requests that are successfully canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsResult.UnsuccessfulFleetRequests"> <summary> Gets and sets the property UnsuccessfulFleetRequests. <para> Information about the Spot fleet requests that are not successfully canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsResponse.CancelSpotFleetRequestsResult"> <summary> Gets and sets the CancelSpotFleetRequestsResult property. Represents the output of a CancelSpotFleetRequests operation. </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotFleetRequestsSuccessItem"> <summary> Describes a Spot fleet request that was successfully canceled. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsSuccessItem.CurrentSpotFleetRequestState"> <summary> Gets and sets the property CurrentSpotFleetRequestState. <para> The current state of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsSuccessItem.PreviousSpotFleetRequestState"> <summary> Gets and sets the property PreviousSpotFleetRequestState. <para> The previous state of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotFleetRequestsSuccessItem.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest"> <summary> Container for the parameters to the CancelSpotInstanceRequests operation. Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <important> <para> Canceling a Spot instance request does not terminate running Spot instances associated with the request. </para> </important> </summary> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates CancelSpotInstanceRequestsRequest with the parameterized properties </summary> <param name="spotInstanceRequestIds">One or more Spot instance request IDs.</param> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsRequest.SpotInstanceRequestIds"> <summary> Gets and sets the property SpotInstanceRequestIds. <para> One or more Spot instance request IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse"> <summary> Configuration for accessing Amazon CancelSpotInstanceRequests service </summary> </member> <member name="T:Amazon.EC2.Model.CancelSpotInstanceRequestsResult"> <summary> Contains the output of CancelSpotInstanceRequests. </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsResult.CancelledSpotInstanceRequests"> <summary> Gets and sets the property CancelledSpotInstanceRequests. <para> One or more Spot instance requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CancelSpotInstanceRequestsResponse.CancelSpotInstanceRequestsResult"> <summary> Gets and sets the CancelSpotInstanceRequestsResult property. Represents the output of a CancelSpotInstanceRequests operation. </summary> </member> <member name="T:Amazon.EC2.Model.ClassicLinkInstance"> <summary> Describes a linked EC2-Classic instance. </summary> </member> <member name="P:Amazon.EC2.Model.ClassicLinkInstance.Groups"> <summary> Gets and sets the property Groups. <para> A list of security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClassicLinkInstance.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClassicLinkInstance.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClassicLinkInstance.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ClientData"> <summary> Describes the client-specific data. </summary> </member> <member name="P:Amazon.EC2.Model.ClientData.Comment"> <summary> Gets and sets the property Comment. <para> A user-defined comment about the disk upload. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClientData.UploadEnd"> <summary> Gets and sets the property UploadEnd. <para> The time that the disk upload ends. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClientData.UploadSize"> <summary> Gets and sets the property UploadSize. <para> The size of the uploaded disk image, in GiB. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ClientData.UploadStart"> <summary> Gets and sets the property UploadStart. <para> The time that the disk upload starts. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceRequest"> <summary> Container for the parameters to the ConfirmProductInstance operation. Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support. </summary> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ConfirmProductInstanceRequest.#ctor(System.String,System.String)"> <summary> Instantiates ConfirmProductInstanceRequest with the parameterized properties </summary> <param name="productCode">The product code. This must be a product code that you own.</param> <param name="instanceId">The ID of the instance.</param> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceRequest.ProductCode"> <summary> Gets and sets the property ProductCode. <para> The product code. This must be a product code that you own. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceResponse"> <summary> Configuration for accessing Amazon ConfirmProductInstance service </summary> </member> <member name="T:Amazon.EC2.Model.ConfirmProductInstanceResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResult.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the instance owner. This is only present if the product code is attached to the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResult.Return"> <summary> Gets and sets the property Return. <para> The return value of the request. Returns <code>true</code> if the specified product code is owned by the requester and associated with the specified instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConfirmProductInstanceResponse.ConfirmProductInstanceResult"> <summary> Gets and sets the ConfirmProductInstanceResult property. Represents the output of a ConfirmProductInstance operation. </summary> </member> <member name="T:Amazon.EC2.Model.ConversionTask"> <summary> Describes a conversion task. </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.ConversionTaskId"> <summary> Gets and sets the property ConversionTaskId. <para> The ID of the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.ExpirationTime"> <summary> Gets and sets the property ExpirationTime. <para> The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.ImportInstance"> <summary> Gets and sets the property ImportInstance. <para> If the task is for importing an instance, this contains information about the import instance task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.ImportVolume"> <summary> Gets and sets the property ImportVolume. <para> If the task is for importing a volume, this contains information about the import volume task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.State"> <summary> Gets and sets the property State. <para> The state of the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> The status message related to the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ConversionTask.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CopyImageRequest"> <summary> Container for the parameters to the CopyImage operation. Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the new AMI in the destination region. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the new AMI in the destination region. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.SourceImageId"> <summary> Gets and sets the property SourceImageId. <para> The ID of the AMI to copy. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageRequest.SourceRegion"> <summary> Gets and sets the property SourceRegion. <para> The name of the region that contains the AMI to copy. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CopyImageResponse"> <summary> Configuration for accessing Amazon CopyImage service </summary> </member> <member name="T:Amazon.EC2.Model.CopyImageResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageResult.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the new AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopyImageResponse.CopyImageResult"> <summary> Gets and sets the CopyImageResult property. Represents the output of a CopyImage operation. </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotRequest"> <summary> Container for the parameters to the CopySnapshot operation. Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to. <para> Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the EBS snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.DestinationRegion"> <summary> Gets and sets the property DestinationRegion. <para> The destination region to use in the <code>PresignedUrl</code> parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a <code>PresignedUrl</code> parameter, where it is required. </para> <note> <para> <code>CopySnapshot</code> sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as <code>ec2.us-east-1.amazonaws.com</code> (in the AWS CLI, this is specified with the <code>--region</code> parameter or the default region in your AWS configuration file). </para> </note> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with <code>KmsKeyId</code>. 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> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the <code>arn:aws:kms</code> namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the <code>key</code> namespace, and then the CMK ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>. The specified CMK must exist in the region that the snapshot is being copied to. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.PresignedUrl"> <summary> Gets and sets the property PresignedUrl. <para> The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The <code>PresignedUrl</code> should use the snapshot source endpoint, the <code>CopySnapshot</code> action, and include the <code>SourceRegion</code>, <code>SourceSnapshotId</code>, and <code>DestinationRegion</code> parameters. The <code>PresignedUrl</code> must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in <a href="http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html">Authenticating Requests by Using Query Parameters (AWS Signature Version 4)</a> in the <i>Amazon Simple Storage Service API Reference</i>. An invalid or improperly signed <code>PresignedUrl</code> will cause the copy operation to fail asynchronously, and the snapshot will move to an <code>error</code> state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.SourceRegion"> <summary> Gets and sets the property SourceRegion. <para> The ID of the region that contains the snapshot to be copied. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotRequest.SourceSnapshotId"> <summary> Gets and sets the property SourceSnapshotId. <para> The ID of the EBS snapshot to copy. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotResponse"> <summary> Configuration for accessing Amazon CopySnapshot service </summary> </member> <member name="T:Amazon.EC2.Model.CopySnapshotResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotResult.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the new snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CopySnapshotResponse.CopySnapshotResult"> <summary> Gets and sets the CopySnapshotResult property. Represents the output of a CopySnapshot operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayRequest"> <summary> Container for the parameters to the CreateCustomerGateway operation. Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT). <para> For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range). </para> <note> <para> Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is reserved in the <code>eu-west-1</code> region. </para> </note> <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources. </para> </important> </summary> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateCustomerGatewayRequest.#ctor(Amazon.EC2.GatewayType,System.String,System.Int32)"> <summary> Instantiates CreateCustomerGatewayRequest with the parameterized properties </summary> <param name="type">The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>).</param> <param name="publicIp">The Internet-routable IP address for the customer gateway's outside interface. The address must be static.</param> <param name="bgpAsn">For devices that support BGP, the customer gateway's BGP ASN. Default: 65000</param> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.BgpAsn"> <summary> Gets and sets the property BgpAsn. <para> For devices that support BGP, the customer gateway's BGP ASN. </para> <para> Default: 65000 </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Internet-routable IP address for the customer gateway's outside interface. The address must be static. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayRequest.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>). </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayResponse"> <summary> Configuration for accessing Amazon CreateCustomerGateway service </summary> </member> <member name="T:Amazon.EC2.Model.CreateCustomerGatewayResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayResult.CustomerGateway"> <summary> Gets and sets the property CustomerGateway. <para> Information about the customer gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateCustomerGatewayResponse.CreateCustomerGatewayResult"> <summary> Gets and sets the CreateCustomerGatewayResult property. Represents the output of a CreateCustomerGateway operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsRequest"> <summary> Container for the parameters to the CreateDhcpOptions operation. Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. <ul> <li> <code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or <code>AmazonProvidedDNS</code>. The default DHCP option set specifies <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.</li> <li> <code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>, specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region, specify <code>region.compute.internal</code> (for example, <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for example, <code>MyCompany.com</code>). <b>Important</b>: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.</li> <li> <code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP) servers.</li> <li> <code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name servers.</li> <li> <code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see <a href="http://www.ietf.org/rfc/rfc2132.txt">RFC 2132</a>. </li> </ul> <para> Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the <code>domain-name-servers</code> option either to <code>AmazonProvidedDNS</code> or to a domain name server of your choice. For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateDhcpOptionsRequest.#ctor(System.Collections.Generic.List{Amazon.EC2.Model.DhcpConfiguration})"> <summary> Instantiates CreateDhcpOptionsRequest with the parameterized properties </summary> <param name="dhcpConfigurations">A DHCP configuration option.</param> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsRequest.DhcpConfigurations"> <summary> Gets and sets the property DhcpConfigurations. <para> A DHCP configuration option. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsResponse"> <summary> Configuration for accessing Amazon CreateDhcpOptions service </summary> </member> <member name="T:Amazon.EC2.Model.CreateDhcpOptionsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsResult.DhcpOptions"> <summary> Gets and sets the property DhcpOptions. <para> A set of DHCP options. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateDhcpOptionsResponse.CreateDhcpOptionsResult"> <summary> Gets and sets the CreateDhcpOptionsResult property. Represents the output of a CreateDhcpOptions operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateFlowLogsRequest"> <summary> Container for the parameters to the CreateFlowLogs operation. Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs. <para> In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.DeliverLogsPermissionArn"> <summary> Gets and sets the property DeliverLogsPermissionArn. <para> The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the CloudWatch log group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.ResourceIds"> <summary> Gets and sets the property ResourceIds. <para> One or more subnet, network interface, or VPC IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The type of resource on which to create the flow log. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsRequest.TrafficType"> <summary> Gets and sets the property TrafficType. <para> The type of traffic to log. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateFlowLogsResponse"> <summary> Configuration for accessing Amazon CreateFlowLogs service </summary> </member> <member name="T:Amazon.EC2.Model.CreateFlowLogsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsResult.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsResult.FlowLogIds"> <summary> Gets and sets the property FlowLogIds. <para> The IDs of the flow logs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsResult.Unsuccessful"> <summary> Gets and sets the property Unsuccessful. <para> Information about the flow logs that could not be created successfully. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateFlowLogsResponse.CreateFlowLogsResult"> <summary> Gets and sets the CreateFlowLogsResult property. Represents the output of a CreateFlowLogs operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageRequest"> <summary> Container for the parameters to the CreateImage operation. Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. <para> If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Creating Amazon EBS-Backed Linux AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateImageRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateImageRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance.</param> <param name="name">A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)</param> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> Information about one or more block device mappings. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the new image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.Name"> <summary> Gets and sets the property Name. <para> A name for the new image. </para> <para> Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageRequest.NoReboot"> <summary> Gets and sets the property NoReboot. <para> By default, this parameter is set to <code>false</code>, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to <code>true</code>, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageResponse"> <summary> Configuration for accessing Amazon CreateImage service </summary> </member> <member name="T:Amazon.EC2.Model.CreateImageResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageResult.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the new AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateImageResponse.CreateImageResult"> <summary> Gets and sets the CreateImageResult property. Represents the output of a CreateImage operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskRequest"> <summary> Container for the parameters to the CreateInstanceExportTask operation. Exports a running or stopped instance to an S3 bucket. <para> For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the conversion task or the resource being exported. The maximum length is 255 bytes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.ExportToS3Task"> <summary> Gets and sets the property ExportToS3Task. <para> The format and location for an instance export task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskRequest.TargetEnvironment"> <summary> Gets and sets the property TargetEnvironment. <para> The target virtualization environment. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskResponse"> <summary> Configuration for accessing Amazon CreateInstanceExportTask service </summary> </member> <member name="T:Amazon.EC2.Model.CreateInstanceExportTaskResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskResult.ExportTask"> <summary> Gets and sets the property ExportTask. <para> Information about the instance export task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInstanceExportTaskResponse.CreateInstanceExportTaskResult"> <summary> Gets and sets the CreateInstanceExportTaskResult property. Represents the output of a CreateInstanceExportTask operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayRequest"> <summary> Container for the parameters to the CreateInternetGateway operation. Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using <a>AttachInternetGateway</a>. <para> For more information about your VPC and Internet gateway, see the <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/">Amazon Virtual Private Cloud User Guide</a>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayResponse"> <summary> Configuration for accessing Amazon CreateInternetGateway service </summary> </member> <member name="T:Amazon.EC2.Model.CreateInternetGatewayResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInternetGatewayResult.InternetGateway"> <summary> Gets and sets the property InternetGateway. <para> Information about the Internet gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateInternetGatewayResponse.CreateInternetGatewayResult"> <summary> Gets and sets the CreateInternetGatewayResult property. Represents the output of a CreateInternetGateway operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairRequest"> <summary> Container for the parameters to the CreateKeyPair operation. Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error. <para> You can have up to five thousand key pairs per region. </para> <para> The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use <a>ImportKeyPair</a>. </para> <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateKeyPairRequest.#ctor(System.String)"> <summary> Instantiates CreateKeyPairRequest with the parameterized properties </summary> <param name="keyName">A unique name for the key pair. Constraints: Up to 255 ASCII characters</param> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> A unique name for the key pair. </para> <para> Constraints: Up to 255 ASCII characters </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairResponse"> <summary> Configuration for accessing Amazon CreateKeyPair service </summary> </member> <member name="T:Amazon.EC2.Model.CreateKeyPairResult"> <summary> Contains the response data from the CreateKeyPair operation. </summary> </member> <member name="P:Amazon.EC2.Model.CreateKeyPairResponse.CreateKeyPairResult"> <summary> Gets and sets the CreateKeyPairResult property. Represents the output of a CreateKeyPair operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclEntryRequest"> <summary> Container for the parameters to the CreateNetworkAclEntry operation. Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. <para> We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. </para> <para> After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. </para> <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The network range to allow or deny, in CIDR notation (for example <code>172.16.0.0/24</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.Egress"> <summary> Gets and sets the property Egress. <para> Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.IcmpTypeCode"> <summary> Gets and sets the property IcmpTypeCode. <para> ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.PortRange"> <summary> Gets and sets the property PortRange. <para> TCP or UDP protocols: The range of ports the rule applies to. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.Protocol"> <summary> Gets and sets the property Protocol. <para> The protocol. A value of -1 means all protocols. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.RuleAction"> <summary> Gets and sets the property RuleAction. <para> Indicates whether to allow or deny the traffic that matches the rule. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclEntryRequest.RuleNumber"> <summary> Gets and sets the property RuleNumber. <para> The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. </para> <para> Constraints: Positive integer from 1 to 32766 </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclRequest"> <summary> Container for the parameters to the CreateNetworkAcl operation. Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclResponse"> <summary> Configuration for accessing Amazon CreateNetworkAcl service </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkAclResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclResult.NetworkAcl"> <summary> Gets and sets the property NetworkAcl. <para> Information about the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkAclResponse.CreateNetworkAclResult"> <summary> Gets and sets the CreateNetworkAclResult property. Represents the output of a CreateNetworkAcl operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceRequest"> <summary> Container for the parameters to the CreateNetworkInterface operation. Creates a network interface in the specified subnet. <para> For more information about network interfaces, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.Groups"> <summary> Gets and sets the property Groups. <para> The IDs of one or more security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in <code>privateIpAddresses</code> as primary (only one IP address can be designated as primary). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> One or more private IP addresses. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.SecondaryPrivateIpAddressCount"> <summary> Gets and sets the property SecondaryPrivateIpAddressCount. <para> The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using <code>privateIpAddresses</code>. </para> <para> The number of IP addresses you can assign to a network interface varies by instance type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI">Private IP Addresses Per ENI Per Instance Type</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet to associate with the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceResponse"> <summary> Configuration for accessing Amazon CreateNetworkInterface service </summary> </member> <member name="T:Amazon.EC2.Model.CreateNetworkInterfaceResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceResult.NetworkInterface"> <summary> Gets and sets the property NetworkInterface. <para> Information about the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateNetworkInterfaceResponse.CreateNetworkInterfaceResult"> <summary> Gets and sets the CreateNetworkInterfaceResult property. Represents the output of a CreateNetworkInterface operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreatePlacementGroupRequest"> <summary> Container for the parameters to the CreatePlacementGroup operation. Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account. <para> For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreatePlacementGroupRequest.#ctor(System.String,Amazon.EC2.PlacementStrategy)"> <summary> Instantiates CreatePlacementGroupRequest with the parameterized properties </summary> <param name="groupName">A name for the placement group. Constraints: Up to 255 ASCII characters</param> <param name="strategy">The placement strategy.</param> </member> <member name="P:Amazon.EC2.Model.CreatePlacementGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> A name for the placement group. </para> <para> Constraints: Up to 255 ASCII characters </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreatePlacementGroupRequest.Strategy"> <summary> Gets and sets the property Strategy. <para> The placement strategy. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingRequest"> <summary> Container for the parameters to the CreateReservedInstancesListing operation. Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the <a>DescribeReservedInstances</a> operation. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the <a>DescribeReservedInstancesListings</a> operation. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.PriceSchedules"> <summary> Gets and sets the property PriceSchedules. <para> A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingRequest.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> The ID of the active Reserved Instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingResponse"> <summary> Configuration for accessing Amazon CreateReservedInstancesListing service </summary> </member> <member name="T:Amazon.EC2.Model.CreateReservedInstancesListingResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingResult.ReservedInstancesListings"> <summary> Gets and sets the property ReservedInstancesListings. <para> Information about the Reserved Instances listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateReservedInstancesListingResponse.CreateReservedInstancesListingResult"> <summary> Gets and sets the CreateReservedInstancesListingResult property. Represents the output of a CreateReservedInstancesListing operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteRequest"> <summary> Container for the parameters to the CreateRoute operation. Creates a route in a route table within a VPC. <para> You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. </para> <para> When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route table includes the following two routes: </para> <ul> <li> <para> <code>192.0.2.0/24</code> (goes to some target A) </para> </li> <li> <para> <code>192.0.2.0/28</code> (goes to some target B) </para> </li> </ul> <para> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR address block used for the destination match. Routing decisions are based on the most specific match. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of an Internet gateway or virtual private gateway attached to your VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of a network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table for the route. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteRequest.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of a VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteResponse"> <summary> Configuration for accessing Amazon CreateRoute service </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteResult.Return"> <summary> Gets and sets the property Return. <para> Returns <code>true</code> if the request succeeds; otherwise, it returns an error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteResponse.CreateRouteResult"> <summary> Gets and sets the CreateRouteResult property. Represents the output of a CreateRoute operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableRequest"> <summary> Container for the parameters to the CreateRouteTable operation. Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableResponse"> <summary> Configuration for accessing Amazon CreateRouteTable service </summary> </member> <member name="T:Amazon.EC2.Model.CreateRouteTableResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableResult.RouteTable"> <summary> Gets and sets the property RouteTable. <para> Information about the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateRouteTableResponse.CreateRouteTableResult"> <summary> Gets and sets the CreateRouteTableResult property. Represents the output of a CreateRouteTable operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupRequest"> <summary> Container for the parameters to the CreateSecurityGroup operation. Creates a security group. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <important> <para> EC2-Classic: You can have up to 500 security groups. </para> <para> EC2-VPC: You can create up to 100 security groups per VPC. </para> </important> <para> When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name. </para> <para> You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. </para> <para> You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateSecurityGroupRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateSecurityGroupRequest with the parameterized properties </summary> <param name="groupName">The name of the security group. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</param> <param name="description">A description for the security group. This is informational only. Constraints: Up to 255 characters in length Constraints for EC2-Classic: ASCII characters Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</param> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the security group. This is informational only. </para> <para> Constraints: Up to 255 characters in length </para> <para> Constraints for EC2-Classic: ASCII characters </para> <para> Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the security group. </para> <para> Constraints: Up to 255 characters in length </para> <para> Constraints for EC2-Classic: ASCII characters </para> <para> Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$* </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> [EC2-VPC] The ID of the VPC. Required for EC2-VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupResponse"> <summary> Configuration for accessing Amazon CreateSecurityGroup service </summary> </member> <member name="T:Amazon.EC2.Model.CreateSecurityGroupResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupResult.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSecurityGroupResponse.CreateSecurityGroupResult"> <summary> Gets and sets the CreateSecurityGroupResult property. Represents the output of a CreateSecurityGroup operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotRequest"> <summary> Container for the parameters to the CreateSnapshot operation. Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. <para> When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. </para> <para> You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>. </para> <para> To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot. </para> <para> Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html">Amazon Elastic Block Store</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateSnapshotRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateSnapshotRequest with the parameterized properties </summary> <param name="volumeId">The ID of the EBS volume.</param> <param name="description">A description for the snapshot.</param> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the EBS volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotResponse"> <summary> Configuration for accessing Amazon CreateSnapshot service </summary> </member> <member name="T:Amazon.EC2.Model.CreateSnapshotResult"> <summary> Contains the response data from the CreateSnapshot operation. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSnapshotResponse.CreateSnapshotResult"> <summary> Gets and sets the CreateSnapshotResult property. Represents the output of a CreateSnapshot operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest"> <summary> Container for the parameters to the CreateSpotDatafeedSubscription operation. Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.#ctor(System.String)"> <summary> Instantiates CreateSpotDatafeedSubscriptionRequest with the parameterized properties </summary> <param name="bucket">The Amazon S3 bucket in which to store the Spot instance data feed.</param> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.Bucket"> <summary> Gets and sets the property Bucket. <para> The Amazon S3 bucket in which to store the Spot instance data feed. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionRequest.Prefix"> <summary> Gets and sets the property Prefix. <para> A prefix for the data feed file names. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse"> <summary> Configuration for accessing Amazon CreateSpotDatafeedSubscription service </summary> </member> <member name="T:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult"> <summary> Contains the output of CreateSpotDatafeedSubscription. </summary> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResult.SpotDatafeedSubscription"> <summary> Gets and sets the property SpotDatafeedSubscription. <para> The Spot instance data feed subscription. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSpotDatafeedSubscriptionResponse.CreateSpotDatafeedSubscriptionResult"> <summary> Gets and sets the CreateSpotDatafeedSubscriptionResult property. Represents the output of a CreateSpotDatafeedSubscription operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetRequest"> <summary> Container for the parameters to the CreateSubnet operation. Creates a subnet in an existing VPC. <para> When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). </para> <important> <para> AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use. </para> </important> <para> If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. </para> <para> If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. </para> <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateSubnetRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateSubnetRequest with the parameterized properties </summary> <param name="vpcId">The ID of the VPC.</param> <param name="cidrBlock">The network range for the subnet, in CIDR notation. For example, <code>10.0.0.0/24</code>.</param> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the subnet. </para> <para> Default: Amazon EC2 selects one for you (recommended). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The network range for the subnet, in CIDR notation. For example, <code>10.0.0.0/24</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetResponse"> <summary> Configuration for accessing Amazon CreateSubnet service </summary> </member> <member name="T:Amazon.EC2.Model.CreateSubnetResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetResult.Subnet"> <summary> Gets and sets the property Subnet. <para> Information about the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateSubnetResponse.CreateSubnetResult"> <summary> Gets and sets the CreateSubnetResult property. Represents the output of a CreateSubnet operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateTagsRequest"> <summary> Container for the parameters to the CreateTags operation. Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateTagsRequest.#ctor(System.Collections.Generic.List{System.String},System.Collections.Generic.List{Amazon.EC2.Model.Tag})"> <summary> Instantiates CreateTagsRequest with the parameterized properties </summary> <param name="resources">The IDs of one or more resources to tag. For example, ami-1a2b3c4d.</param> <param name="tags">One or more tags. The <code>value</code> parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </param> </member> <member name="P:Amazon.EC2.Model.CreateTagsRequest.Resources"> <summary> Gets and sets the property Resources. <para> The IDs of one or more resources to tag. For example, ami-1a2b3c4d. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags. The <code>value</code> parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumePermission"> <summary> Describes the user or group to be added or removed from the permissions for a volume. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermission.Group"> <summary> Gets and sets the property Group. <para> The specific group that is to be added or removed from a volume's list of create volume permissions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermission.UserId"> <summary> Gets and sets the property UserId. <para> The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumePermissionModifications"> <summary> Describes modifications to the permissions for a volume. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermissionModifications.Add"> <summary> Gets and sets the property Add. <para> Adds a specific AWS account ID or group to a volume's list of create volume permissions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumePermissionModifications.Remove"> <summary> Gets and sets the property Remove. <para> Removes a specific AWS account ID or group from a volume's list of create volume permissions. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeRequest"> <summary> Container for the parameters to the CreateVolume operation. Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html">Regions and Endpoints</a>. <para> You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. </para> <para> You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.#ctor(System.String,System.Int32)"> <summary> Instantiates CreateVolumeRequest with the parameterized properties </summary> <param name="availabilityZone">The Availability Zone in which to create the volume. Use <a>DescribeAvailabilityZones</a> to list the Availability Zones that are currently available to you.</param> <param name="size">The size of the volume, in GiBs. Constraints: <code>1-1024</code> for <code>standard</code> volumes, <code>1-16384</code> for <code>gp2</code> volumes, and <code>4-16384</code> for <code>io1</code> volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.</param> </member> <member name="M:Amazon.EC2.Model.CreateVolumeRequest.#ctor(System.String,System.String)"> <summary> Instantiates CreateVolumeRequest with the parameterized properties </summary> <param name="availabilityZone">The Availability Zone in which to create the volume. Use <a>DescribeAvailabilityZones</a> to list the Availability Zones that are currently available to you.</param> <param name="snapshotId">The snapshot from which to create the volume.</param> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which to create the volume. Use <a>DescribeAvailabilityZones</a> to list the Availability Zones that are currently available to you. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. 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> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.Iops"> <summary> Gets and sets the property Iops. <para> Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB. </para> <para> Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the <code>arn:aws:kms</code> namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the <code>key</code> namespace, and then the CMK ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.Size"> <summary> Gets and sets the property Size. <para> The size of the volume, in GiBs. </para> <para> Constraints: <code>1-1024</code> for <code>standard</code> volumes, <code>1-16384</code> for <code>gp2</code> volumes, and <code>4-16384</code> for <code>io1</code> volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. </para> <para> Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot from which to create the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeRequest.VolumeType"> <summary> Gets and sets the property VolumeType. <para> The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes. </para> <para> Default: <code>standard</code> </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeResponse"> <summary> Configuration for accessing Amazon CreateVolume service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVolumeResult"> <summary> Contains the response data from the CreateVolume operation. </summary> </member> <member name="P:Amazon.EC2.Model.CreateVolumeResponse.CreateVolumeResult"> <summary> Gets and sets the CreateVolumeResult property. Represents the output of a CreateVolume operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcEndpointRequest"> <summary> Container for the parameters to the CreateVpcEndpoint operation. Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint. <para> Currently, only endpoints to Amazon S3 are supported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">How to Ensure Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointRequest.PolicyDocument"> <summary> Gets and sets the property PolicyDocument. <para> A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointRequest.RouteTableIds"> <summary> Gets and sets the property RouteTableIds. <para> One or more route table IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointRequest.ServiceName"> <summary> Gets and sets the property ServiceName. <para> The AWS service name, in the form <code>com.amazonaws.<i>region</i>.<i>service</i></code>. To get a list of available services, use the <a>DescribeVpcEndpointServices</a> request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC in which the endpoint will be used. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcEndpointResponse"> <summary> Configuration for accessing Amazon CreateVpcEndpoint service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcEndpointResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointResult.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointResult.VpcEndpoint"> <summary> Gets and sets the property VpcEndpoint. <para> Information about the endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcEndpointResponse.CreateVpcEndpointResult"> <summary> Gets and sets the CreateVpcEndpointResult property. Represents the output of a CreateVpcEndpoint operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest"> <summary> Container for the parameters to the CreateVpcPeeringConnection operation. Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks. <para> The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. </para> <para> A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of <code>failed</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.PeerOwnerId"> <summary> Gets and sets the property PeerOwnerId. <para> The AWS account ID of the owner of the peer VPC. </para> <para> Default: Your AWS account ID </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.PeerVpcId"> <summary> Gets and sets the property PeerVpcId. <para> The ID of the VPC with which you are creating the VPC peering connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the requester VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse"> <summary> Configuration for accessing Amazon CreateVpcPeeringConnection service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcPeeringConnectionResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionResult.VpcPeeringConnection"> <summary> Gets and sets the property VpcPeeringConnection. <para> Information about the VPC peering connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcPeeringConnectionResponse.CreateVpcPeeringConnectionResult"> <summary> Gets and sets the CreateVpcPeeringConnectionResult property. Represents the output of a CreateVpcPeeringConnection operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcRequest"> <summary> Container for the parameters to the CreateVpc operation. Creates a VPC with the specified CIDR block. <para> The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> <para> By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpcRequest.#ctor(System.String)"> <summary> Instantiates CreateVpcRequest with the parameterized properties </summary> <param name="cidrBlock">The network range for the VPC, in CIDR notation. For example, <code>10.0.0.0/16</code>.</param> </member> <member name="P:Amazon.EC2.Model.CreateVpcRequest.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The network range for the VPC, in CIDR notation. For example, <code>10.0.0.0/16</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcRequest.InstanceTenancy"> <summary> Gets and sets the property InstanceTenancy. <para> The supported tenancy options for instances launched into the VPC. A value of <code>default</code> means that instances can be launched with any tenancy; a value of <code>dedicated</code> means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware. </para> <para> Default: <code>default</code> </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcResponse"> <summary> Configuration for accessing Amazon CreateVpc service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpcResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcResult.Vpc"> <summary> Gets and sets the property Vpc. <para> Information about the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpcResponse.CreateVpcResult"> <summary> Gets and sets the CreateVpcResult property. Represents the output of a CreateVpc operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionRequest"> <summary> Container for the parameters to the CreateVpnConnection operation. Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is <code>ipsec.1</code>. <para> The response includes information that you need to give to your network administrator to configure your customer gateway. </para> <important> <para> We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. </para> </important> <para> If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. </para> <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnConnectionRequest.#ctor(System.String,System.String,System.String)"> <summary> Instantiates CreateVpnConnectionRequest with the parameterized properties </summary> <param name="type">The type of VPN connection (<code>ipsec.1</code>).</param> <param name="customerGatewayId">The ID of the customer gateway.</param> <param name="vpnGatewayId">The ID of the virtual private gateway.</param> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.CustomerGatewayId"> <summary> Gets and sets the property CustomerGatewayId. <para> The ID of the customer gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.Options"> <summary> Gets and sets the property Options. <para> Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify <code>true</code>. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection (<code>ipsec.1</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRequest.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionResponse"> <summary> Configuration for accessing Amazon CreateVpnConnection service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionResult.VpnConnection"> <summary> Gets and sets the property VpnConnection. <para> Information about the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionResponse.CreateVpnConnectionResult"> <summary> Gets and sets the CreateVpnConnectionResult property. Represents the output of a CreateVpnConnection operation. </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnConnectionRouteRequest"> <summary> Container for the parameters to the CreateVpnConnectionRoute operation. Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR block associated with the local subnet of the customer network. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnConnectionRouteRequest.VpnConnectionId"> <summary> Gets and sets the property VpnConnectionId. <para> The ID of the VPN connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayRequest"> <summary> Container for the parameters to the CreateVpnGateway operation. Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.CreateVpnGatewayRequest.#ctor(Amazon.EC2.GatewayType)"> <summary> Instantiates CreateVpnGatewayRequest with the parameterized properties </summary> <param name="type">The type of VPN connection this virtual private gateway supports.</param> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayRequest.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection this virtual private gateway supports. </para> </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayResponse"> <summary> Configuration for accessing Amazon CreateVpnGateway service </summary> </member> <member name="T:Amazon.EC2.Model.CreateVpnGatewayResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayResult.VpnGateway"> <summary> Gets and sets the property VpnGateway. <para> Information about the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CreateVpnGatewayResponse.CreateVpnGatewayResult"> <summary> Gets and sets the CreateVpnGatewayResult property. Represents the output of a CreateVpnGateway operation. </summary> </member> <member name="T:Amazon.EC2.Model.CustomerGateway"> <summary> Describes a customer gateway. </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.BgpAsn"> <summary> Gets and sets the property BgpAsn. <para> The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.CustomerGatewayId"> <summary> Gets and sets the property CustomerGatewayId. <para> The ID of the customer gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.IpAddress"> <summary> Gets and sets the property IpAddress. <para> The Internet-routable IP address of the customer gateway's outside interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.State"> <summary> Gets and sets the property State. <para> The current state of the customer gateway (<code>pending | available | deleting | deleted</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the customer gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.CustomerGateway.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection the customer gateway supports (<code>ipsec.1</code>). </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteCustomerGatewayRequest"> <summary> Container for the parameters to the DeleteCustomerGateway operation. Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteCustomerGatewayRequest.#ctor(System.String)"> <summary> Instantiates DeleteCustomerGatewayRequest with the parameterized properties </summary> <param name="customerGatewayId">The ID of the customer gateway.</param> </member> <member name="P:Amazon.EC2.Model.DeleteCustomerGatewayRequest.CustomerGatewayId"> <summary> Gets and sets the property CustomerGatewayId. <para> The ID of the customer gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteDhcpOptionsRequest"> <summary> Container for the parameters to the DeleteDhcpOptions operation. Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteDhcpOptionsRequest.#ctor(System.String)"> <summary> Instantiates DeleteDhcpOptionsRequest with the parameterized properties </summary> <param name="dhcpOptionsId">The ID of the DHCP options set.</param> </member> <member name="P:Amazon.EC2.Model.DeleteDhcpOptionsRequest.DhcpOptionsId"> <summary> Gets and sets the property DhcpOptionsId. <para> The ID of the DHCP options set. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteFlowLogsRequest"> <summary> Container for the parameters to the DeleteFlowLogs operation. Deletes one or more flow logs. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteFlowLogsRequest.FlowLogIds"> <summary> Gets and sets the property FlowLogIds. <para> One or more flow log IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteFlowLogsResponse"> <summary> Configuration for accessing Amazon DeleteFlowLogs service </summary> </member> <member name="T:Amazon.EC2.Model.DeleteFlowLogsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteFlowLogsResult.Unsuccessful"> <summary> Gets and sets the property Unsuccessful. <para> Information about the flow logs that could not be deleted successfully. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteFlowLogsResponse.DeleteFlowLogsResult"> <summary> Gets and sets the DeleteFlowLogsResult property. Represents the output of a DeleteFlowLogs operation. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteInternetGatewayRequest"> <summary> Container for the parameters to the DeleteInternetGateway operation. Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteInternetGatewayRequest.InternetGatewayId"> <summary> Gets and sets the property InternetGatewayId. <para> The ID of the Internet gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteKeyPairRequest"> <summary> Container for the parameters to the DeleteKeyPair operation. Deletes the specified key pair, by removing the public key from Amazon EC2. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteKeyPairRequest.#ctor(System.String)"> <summary> Instantiates DeleteKeyPairRequest with the parameterized properties </summary> <param name="keyName">The name of the key pair.</param> </member> <member name="P:Amazon.EC2.Model.DeleteKeyPairRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclEntryRequest"> <summary> Container for the parameters to the DeleteNetworkAclEntry operation. Deletes the specified ingress or egress entry (rule) from the specified network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.Egress"> <summary> Gets and sets the property Egress. <para> Indicates whether the rule is an egress rule. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclEntryRequest.RuleNumber"> <summary> Gets and sets the property RuleNumber. <para> The rule number of the entry to delete. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkAclRequest"> <summary> Container for the parameters to the DeleteNetworkAcl operation. Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkAclRequest.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the network ACL. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteNetworkInterfaceRequest"> <summary> Container for the parameters to the DeleteNetworkInterface operation. Deletes the specified network interface. You must detach the network interface before you can delete it. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteNetworkInterfaceRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeletePlacementGroupRequest"> <summary> Container for the parameters to the DeletePlacementGroup operation. Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeletePlacementGroupRequest.#ctor(System.String)"> <summary> Instantiates DeletePlacementGroupRequest with the parameterized properties </summary> <param name="groupName">The name of the placement group.</param> </member> <member name="P:Amazon.EC2.Model.DeletePlacementGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the placement group. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteRequest"> <summary> Container for the parameters to the DeleteRoute operation. Deletes the specified route from the specified route table. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteRouteRequest.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR range for the route. The value you specify must match the CIDR for the route exactly. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteRouteRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteRouteTableRequest"> <summary> Container for the parameters to the DeleteRouteTable operation. Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteRouteTableRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSecurityGroupRequest"> <summary> Container for the parameters to the DeleteSecurityGroup operation. Deletes a security group. <para> If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSecurityGroupRequest.#ctor(System.String)"> <summary> Instantiates DeleteSecurityGroupRequest with the parameterized properties </summary> <param name="groupName">[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.</param> </member> <member name="P:Amazon.EC2.Model.DeleteSecurityGroupRequest.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. Required for a nondefault VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteSecurityGroupRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> [EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSnapshotRequest"> <summary> Container for the parameters to the DeleteSnapshot operation. Deletes the specified snapshot. <para> When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. </para> <para> You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSnapshotRequest.#ctor(System.String)"> <summary> Instantiates DeleteSnapshotRequest with the parameterized properties </summary> <param name="snapshotId">The ID of the EBS snapshot.</param> </member> <member name="P:Amazon.EC2.Model.DeleteSnapshotRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the EBS snapshot. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSpotDatafeedSubscriptionRequest"> <summary> Container for the parameters to the DeleteSpotDatafeedSubscription operation. Deletes the data feed for Spot instances. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteSubnetRequest"> <summary> Container for the parameters to the DeleteSubnet operation. Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteSubnetRequest.#ctor(System.String)"> <summary> Instantiates DeleteSubnetRequest with the parameterized properties </summary> <param name="subnetId">The ID of the subnet.</param> </member> <member name="P:Amazon.EC2.Model.DeleteSubnetRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteTagsRequest"> <summary> Container for the parameters to the DeleteTags operation. Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteTagsRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates DeleteTagsRequest with the parameterized properties </summary> <param name="resources">The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.</param> </member> <member name="P:Amazon.EC2.Model.DeleteTagsRequest.Resources"> <summary> Gets and sets the property Resources. <para> The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteTagsRequest.Tags"> <summary> Gets and sets the property Tags. <para> One or more tags to delete. If you omit the <code>value</code> parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVolumeRequest"> <summary> Container for the parameters to the DeleteVolume operation. Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance). <note> <para> The volume may remain in the <code>deleting</code> state for several minutes. </para> </note> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVolumeRequest.#ctor(System.String)"> <summary> Instantiates DeleteVolumeRequest with the parameterized properties </summary> <param name="volumeId">The ID of the volume.</param> </member> <member name="P:Amazon.EC2.Model.DeleteVolumeRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcEndpointsRequest"> <summary> Container for the parameters to the DeleteVpcEndpoints operation. Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpcEndpointsRequest.VpcEndpointIds"> <summary> Gets and sets the property VpcEndpointIds. <para> One or more endpoint IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcEndpointsResponse"> <summary> Configuration for accessing Amazon DeleteVpcEndpoints service </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcEndpointsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpcEndpointsResult.Unsuccessful"> <summary> Gets and sets the property Unsuccessful. <para> Information about the endpoints that were not successfully deleted. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpcEndpointsResponse.DeleteVpcEndpointsResult"> <summary> Gets and sets the DeleteVpcEndpointsResult property. Represents the output of a DeleteVpcEndpoints operation. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest"> <summary> Container for the parameters to the DeleteVpcPeeringConnection operation. Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the <code>active</code> state. The owner of the requester VPC can delete a VPC peering connection in the <code>pending-acceptance</code> state. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of the VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcPeeringConnectionResponse"> <summary> Returns information about the DeleteVpcPeeringConnection response metadata. The DeleteVpcPeeringConnection operation has a void result type. </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpcRequest"> <summary> Container for the parameters to the DeleteVpc operation. Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpcRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpcRequest.#ctor(System.String)"> <summary> Instantiates DeleteVpcRequest with the parameterized properties </summary> <param name="vpcId">The ID of the VPC.</param> </member> <member name="P:Amazon.EC2.Model.DeleteVpcRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionRequest"> <summary> Container for the parameters to the DeleteVpnConnection operation. Deletes the specified VPN connection. <para> If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnConnectionRequest.#ctor(System.String)"> <summary> Instantiates DeleteVpnConnectionRequest with the parameterized properties </summary> <param name="vpnConnectionId">The ID of the VPN connection.</param> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRequest.VpnConnectionId"> <summary> Gets and sets the property VpnConnectionId. <para> The ID of the VPN connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest"> <summary> Container for the parameters to the DeleteVpnConnectionRoute operation. Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR block associated with the local subnet of the customer network. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DeleteVpnConnectionRouteRequest.VpnConnectionId"> <summary> Gets and sets the property VpnConnectionId. <para> The ID of the VPN connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeleteVpnGatewayRequest"> <summary> Container for the parameters to the DeleteVpnGateway operation. Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeleteVpnGatewayRequest.#ctor(System.String)"> <summary> Instantiates DeleteVpnGatewayRequest with the parameterized properties </summary> <param name="vpnGatewayId">The ID of the virtual private gateway.</param> </member> <member name="P:Amazon.EC2.Model.DeleteVpnGatewayRequest.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DeregisterImageRequest"> <summary> Container for the parameters to the DeregisterImage operation. Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances. <para> This command does not delete the AMI. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DeregisterImageRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DeregisterImageRequest.#ctor(System.String)"> <summary> Instantiates DeregisterImageRequest with the parameterized properties </summary> <param name="imageId">The ID of the AMI.</param> </member> <member name="P:Amazon.EC2.Model.DeregisterImageRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesRequest"> <summary> Container for the parameters to the DescribeAccountAttributes operation. Describes attributes of your AWS account. The following are the supported account attributes: <ul> <li> <para> <code>supported-platforms</code>: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC. </para> </li> <li> <para> <code>default-vpc</code>: The ID of the default VPC for your account, or <code>none</code>. </para> </li> <li> <para> <code>max-instances</code>: The maximum number of On-Demand instances that you can run. </para> </li> <li> <para> <code>vpc-max-security-groups-per-interface</code>: The maximum number of security groups that you can assign to a network interface. </para> </li> <li> <para> <code>max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic. </para> </li> <li> <para> <code>vpc-max-elastic-ips</code>: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesRequest.AttributeNames"> <summary> Gets and sets the property AttributeNames. <para> One or more account attribute names. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesResponse"> <summary> Configuration for accessing Amazon DescribeAccountAttributes service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAccountAttributesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesResult.AccountAttributes"> <summary> Gets and sets the property AccountAttributes. <para> Information about one or more account attributes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAccountAttributesResponse.DescribeAccountAttributesResult"> <summary> Gets and sets the DescribeAccountAttributesResult property. Represents the output of a DescribeAccountAttributes operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesRequest"> <summary> Container for the parameters to the DescribeAddresses operation. Describes one or more of your Elastic IP addresses. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.AllocationIds"> <summary> Gets and sets the property AllocationIds. <para> [EC2-VPC] One or more allocation IDs. </para> <para> Default: Describes all your Elastic IP addresses. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. Filter names and values are case-sensitive. </para> <ul> <li> <para> <code>allocation-id</code> - [EC2-VPC] The allocation ID for the address. </para> </li> <li> <para> <code>association-id</code> - [EC2-VPC] The association ID for the address. </para> </li> <li> <para> <code>domain</code> - Indicates whether the address is for use in EC2-Classic (<code>standard</code>) or in a VPC (<code>vpc</code>). </para> </li> <li> <para> <code>instance-id</code> - The ID of the instance the address is associated with, if any. </para> </li> <li> <para> <code>network-interface-id</code> - [EC2-VPC] The ID of the network interface that the address is associated with, if any. </para> </li> <li> <para> <code>network-interface-owner-id</code> - The AWS account ID of the owner. </para> </li> <li> <para> <code>private-ip-address</code> - [EC2-VPC] The private IP address associated with the Elastic IP address. </para> </li> <li> <para> <code>public-ip</code> - The Elastic IP address. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesRequest.PublicIps"> <summary> Gets and sets the property PublicIps. <para> [EC2-Classic] One or more Elastic IP addresses. </para> <para> Default: Describes all your Elastic IP addresses. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesResponse"> <summary> Configuration for accessing Amazon DescribeAddresses service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAddressesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesResult.Addresses"> <summary> Gets and sets the property Addresses. <para> Information about one or more Elastic IP addresses. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAddressesResponse.DescribeAddressesResult"> <summary> Gets and sets the DescribeAddressesResult property. Represents the output of a DescribeAddresses operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesRequest"> <summary> Container for the parameters to the DescribeAvailabilityZones operation. Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html">Regions and Availability Zones</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>message</code> - Information about the Availability Zone. </para> </li> <li> <para> <code>region-name</code> - The name of the region for the Availability Zone (for example, <code>us-east-1</code>). </para> </li> <li> <para> <code>state</code> - The state of the Availability Zone (<code>available</code> | <code>impaired</code> | <code>unavailable</code>). </para> </li> <li> <para> <code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesRequest.ZoneNames"> <summary> Gets and sets the property ZoneNames. <para> The names of one or more Availability Zones. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesResponse"> <summary> Configuration for accessing Amazon DescribeAvailabilityZones service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeAvailabilityZonesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesResult.AvailabilityZones"> <summary> Gets and sets the property AvailabilityZones. <para> Information about one or more Availability Zones. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeAvailabilityZonesResponse.DescribeAvailabilityZonesResult"> <summary> Gets and sets the DescribeAvailabilityZonesResult property. Represents the output of a DescribeAvailabilityZones operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksRequest"> <summary> Container for the parameters to the DescribeBundleTasks operation. Describes one or more of your bundling tasks. <note> <para> Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task. </para> </note> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksRequest.BundleIds"> <summary> Gets and sets the property BundleIds. <para> One or more bundle task IDs. </para> <para> Default: Describes all your bundle tasks. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>bundle-id</code> - The ID of the bundle task. </para> </li> <li> <para> <code>error-code</code> - If the task failed, the error code returned. </para> </li> <li> <para> <code>error-message</code> - If the task failed, the error message returned. </para> </li> <li> <para> <code>instance-id</code> - The ID of the instance. </para> </li> <li> <para> <code>progress</code> - The level of task completion, as a percentage (for example, 20%). </para> </li> <li> <para> <code>s3-bucket</code> - The Amazon S3 bucket to store the AMI. </para> </li> <li> <para> <code>s3-prefix</code> - The beginning of the AMI name. </para> </li> <li> <para> <code>start-time</code> - The time the task started (for example, 2013-09-15T17:15:20.000Z). </para> </li> <li> <para> <code>state</code> - The state of the task (<code>pending</code> | <code>waiting-for-shutdown</code> | <code>bundling</code> | <code>storing</code> | <code>cancelling</code> | <code>complete</code> | <code>failed</code>). </para> </li> <li> <para> <code>update-time</code> - The time of the most recent update for the task. </para> </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksResponse"> <summary> Configuration for accessing Amazon DescribeBundleTasks service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeBundleTasksResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksResult.BundleTasks"> <summary> Gets and sets the property BundleTasks. <para> Information about one or more bundle tasks. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeBundleTasksResponse.DescribeBundleTasksResult"> <summary> Gets and sets the DescribeBundleTasksResult property. Represents the output of a DescribeBundleTasks operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeClassicLinkInstancesRequest"> <summary> Container for the parameters to the DescribeClassicLinkInstances operation. Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>group-id</code> - The ID of a VPC security group that's associated with the instance. </para> </li> <li> <para> <code>instance-id</code> - The ID of the instance. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC that the instance is linked to. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. Must be instances linked to a VPC through ClassicLink. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request. </para> <para> Constraint: If the value is greater than 1000, we return only 1000 items. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeClassicLinkInstancesResponse"> <summary> Configuration for accessing Amazon DescribeClassicLinkInstances service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeClassicLinkInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesResult.Instances"> <summary> Gets and sets the property Instances. <para> Information about one or more linked EC2-Classic instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeClassicLinkInstancesResponse.DescribeClassicLinkInstancesResult"> <summary> Gets and sets the DescribeClassicLinkInstancesResult property. Represents the output of a DescribeClassicLinkInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksRequest"> <summary> Container for the parameters to the DescribeConversionTasks operation. Describes one or more of your conversion tasks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksRequest.ConversionTaskIds"> <summary> Gets and sets the property ConversionTaskIds. <para> One or more conversion task IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksResponse"> <summary> Configuration for accessing Amazon DescribeConversionTasks service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeConversionTasksResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksResult.ConversionTasks"> <summary> Gets and sets the property ConversionTasks. <para> Information about the conversion tasks. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeConversionTasksResponse.DescribeConversionTasksResult"> <summary> Gets and sets the DescribeConversionTasksResult property. Represents the output of a DescribeConversionTasks operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysRequest"> <summary> Container for the parameters to the DescribeCustomerGateways operation. Describes one or more of your VPN customer gateways. <para> For more information about VPN customer gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.CustomerGatewayIds"> <summary> Gets and sets the property CustomerGatewayIds. <para> One or more customer gateway IDs. </para> <para> Default: Describes all your customer gateways. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>bgp-asn</code> - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). </para> </li> <li> <para> <code>customer-gateway-id</code> - The ID of the customer gateway. </para> </li> <li> <para> <code>ip-address</code> - The IP address of the customer gateway's Internet-routable external interface. </para> </li> <li> <para> <code>state</code> - The state of the customer gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>). </para> </li> <li> <para> <code>type</code> - The type of customer gateway. Currently, the only supported type is <code>ipsec.1</code>. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysResponse"> <summary> Configuration for accessing Amazon DescribeCustomerGateways service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeCustomerGatewaysResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysResult.CustomerGateways"> <summary> Gets and sets the property CustomerGateways. <para> Information about one or more customer gateways. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeCustomerGatewaysResponse.DescribeCustomerGatewaysResult"> <summary> Gets and sets the DescribeCustomerGatewaysResult property. Represents the output of a DescribeCustomerGateways operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsRequest"> <summary> Container for the parameters to the DescribeDhcpOptions operation. Describes one or more of your DHCP options sets. <para> For more information about DHCP options sets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html">DHCP Options Sets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsRequest.DhcpOptionsIds"> <summary> Gets and sets the property DhcpOptionsIds. <para> The IDs of one or more DHCP options sets. </para> <para> Default: Describes all your DHCP options sets. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>dhcp-options-id</code> - The ID of a set of DHCP options. </para> </li> <li> <para> <code>key</code> - The key for one of the options (for example, <code>domain-name</code>). </para> </li> <li> <para> <code>value</code> - The value for one of the options. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsResponse"> <summary> Configuration for accessing Amazon DescribeDhcpOptions service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeDhcpOptionsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsResult.DhcpOptions"> <summary> Gets and sets the property DhcpOptions. <para> Information about one or more DHCP options sets. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeDhcpOptionsResponse.DescribeDhcpOptionsResult"> <summary> Gets and sets the DescribeDhcpOptionsResult property. Represents the output of a DescribeDhcpOptions operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksRequest"> <summary> Container for the parameters to the DescribeExportTasks operation. Describes one or more of your export tasks. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksRequest.ExportTaskIds"> <summary> Gets and sets the property ExportTaskIds. <para> One or more export task IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksResponse"> <summary> Configuration for accessing Amazon DescribeExportTasks service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeExportTasksResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksResult.ExportTasks"> <summary> Gets and sets the property ExportTasks. <para> Information about the export tasks. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeExportTasksResponse.DescribeExportTasksResult"> <summary> Gets and sets the DescribeExportTasksResult property. Represents the output of a DescribeExportTasks operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeFlowLogsRequest"> <summary> Container for the parameters to the DescribeFlowLogs operation. Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsRequest.Filter"> <summary> Gets and sets the property Filter. <para> One or more filters. </para> <ul> <li> <para> <code>deliver-log-status</code> - The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>). </para> </li> <li> <para> <code>flow-log-id</code> - The ID of the flow log. </para> </li> <li> <para> <code>log-group-name</code> - The name of the log group. </para> </li> <li> <para> <code>resource-id</code> - The ID of the VPC, subnet, or network interface. </para> </li> <li> <para> <code>traffic-type</code> - The type of traffic (<code>ACCEPT</code> | <code>REJECT</code> | <code>ALL</code>) </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsRequest.FlowLogIds"> <summary> Gets and sets the property FlowLogIds. <para> One or more flow log IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeFlowLogsResponse"> <summary> Configuration for accessing Amazon DescribeFlowLogs service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeFlowLogsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsResult.FlowLogs"> <summary> Gets and sets the property FlowLogs. <para> Information about the flow logs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeFlowLogsResponse.DescribeFlowLogsResult"> <summary> Gets and sets the DescribeFlowLogsResult property. Represents the output of a DescribeFlowLogs operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeRequest"> <summary> Container for the parameters to the DescribeImageAttribute operation. Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DescribeImageAttributeRequest.#ctor(System.String,Amazon.EC2.ImageAttributeName)"> <summary> Instantiates DescribeImageAttributeRequest with the parameterized properties </summary> <param name="imageId">The ID of the AMI.</param> <param name="attribute">The AMI attribute. <b>Note</b>: Depending on your account privileges, the <code>blockDeviceMapping</code> attribute may return a <code>Client.AuthFailure</code> error. If this happens, use <a>DescribeImages</a> to get information about the block device mapping for the AMI.</param> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The AMI attribute. </para> <para> <b>Note</b>: Depending on your account privileges, the <code>blockDeviceMapping</code> attribute may return a <code>Client.AuthFailure</code> error. If this happens, use <a>DescribeImages</a> to get information about the block device mapping for the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeResponse"> <summary> Configuration for accessing Amazon DescribeImageAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImageAttributeResult"> <summary> Contains the response data from the DescribeImageAttribute operation. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImageAttributeResponse.DescribeImageAttributeResult"> <summary> Gets and sets the DescribeImageAttributeResult property. Represents the output of a DescribeImageAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesRequest"> <summary> Container for the parameters to the DescribeImages operation. Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions. <note> <para> Deregistered images are included in the returned results for an unspecified interval after deregistration. </para> </note> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.ExecutableUsers"> <summary> Gets and sets the property ExecutableUsers. <para> Scopes the images by users with explicit launch permissions. Specify an AWS account ID, <code>self</code> (the sender of the request), or <code>all</code> (public AMIs). </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code>). </para> </li> <li> <para> <code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. </para> </li> <li> <para> <code>block-device-mapping.device-name</code> - The device name for the EBS volume (for example, <code>/dev/sdh</code>). </para> </li> <li> <para> <code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the EBS volume. </para> </li> <li> <para> <code>block-device-mapping.volume-size</code> - The volume size of the EBS volume, in GiB. </para> </li> <li> <para> <code>block-device-mapping.volume-type</code> - The volume type of the EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>). </para> </li> <li> <para> <code>description</code> - The description of the image (provided during image creation). </para> </li> <li> <para> <code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>). </para> </li> <li> <para> <code>image-id</code> - The ID of the image. </para> </li> <li> <para> <code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>). </para> </li> <li> <para> <code>is-public</code> - A Boolean that indicates whether the image is public. </para> </li> <li> <para> <code>kernel-id</code> - The kernel ID. </para> </li> <li> <para> <code>manifest-location</code> - The location of the image manifest. </para> </li> <li> <para> <code>name</code> - The name of the AMI (provided during image creation). </para> </li> <li> <para> <code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>). </para> </li> <li> <para> <code>owner-id</code> - The AWS account ID of the image owner. </para> </li> <li> <para> <code>platform</code> - The platform. To only list Windows-based AMIs, use <code>windows</code>. </para> </li> <li> <para> <code>product-code</code> - The product code. </para> </li> <li> <para> <code>product-code.type</code> - The type of the product code (<code>devpay</code> | <code>marketplace</code>). </para> </li> <li> <para> <code>ramdisk-id</code> - The RAM disk ID. </para> </li> <li> <para> <code>root-device-name</code> - The name of the root device volume (for example, <code>/dev/sda1</code>). </para> </li> <li> <para> <code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>). </para> </li> <li> <para> <code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>). </para> </li> <li> <para> <code>state-reason-code</code> - The reason code for the state change. </para> </li> <li> <para> <code>state-reason-message</code> - The message for the state change. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.ImageIds"> <summary> Gets and sets the property ImageIds. <para> One or more image IDs. </para> <para> Default: Describes all images available to you. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesRequest.Owners"> <summary> Gets and sets the property Owners. <para> Filters the images by the owner. Specify an AWS account ID, <code>amazon</code> (owner is Amazon), <code>aws-marketplace</code> (owner is AWS Marketplace), <code>self</code> (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesResponse"> <summary> Configuration for accessing Amazon DescribeImages service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImagesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesResult.Images"> <summary> Gets and sets the property Images. <para> Information about one or more images. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImagesResponse.DescribeImagesResult"> <summary> Gets and sets the DescribeImagesResult property. Represents the output of a DescribeImages operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportImageTasksRequest"> <summary> Container for the parameters to the DescribeImportImageTasks operation. Displays details about an import virtual machine or import snapshot tasks that are already created. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksRequest.ImportTaskIds"> <summary> Gets and sets the property ImportTaskIds. <para> A list of import image task IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A token that indicates the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportImageTasksResponse"> <summary> Configuration for accessing Amazon DescribeImportImageTasks service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportImageTasksResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksResult.ImportImageTasks"> <summary> Gets and sets the property ImportImageTasks. <para> A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to get the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportImageTasksResponse.DescribeImportImageTasksResult"> <summary> Gets and sets the DescribeImportImageTasksResult property. Represents the output of a DescribeImportImageTasks operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportSnapshotTasksRequest"> <summary> Container for the parameters to the DescribeImportSnapshotTasks operation. Describes your import snapshot tasks. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksRequest.ImportTaskIds"> <summary> Gets and sets the property ImportTaskIds. <para> A list of import snapshot task IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> A token that indicates the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportSnapshotTasksResponse"> <summary> Configuration for accessing Amazon DescribeImportSnapshotTasks service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeImportSnapshotTasksResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksResult.ImportSnapshotTasks"> <summary> Gets and sets the property ImportSnapshotTasks. <para> A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to get the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeImportSnapshotTasksResponse.DescribeImportSnapshotTasksResult"> <summary> Gets and sets the DescribeImportSnapshotTasksResult property. Represents the output of a DescribeImportSnapshotTasks operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeRequest"> <summary> Container for the parameters to the DescribeInstanceAttribute operation. Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DescribeInstanceAttributeRequest.#ctor(System.String,Amazon.EC2.InstanceAttributeName)"> <summary> Instantiates DescribeInstanceAttributeRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance.</param> <param name="attribute">The instance attribute.</param> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The instance attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeResponse"> <summary> Configuration for accessing Amazon DescribeInstanceAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceAttributeResult"> <summary> Contains the response data from the DescribeInstanceAttribute operation. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceAttributeResponse.DescribeInstanceAttributeResult"> <summary> Gets and sets the DescribeInstanceAttributeResult property. Represents the output of a DescribeInstanceAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesRequest"> <summary> Container for the parameters to the DescribeInstances operation. Describes one or more of your instances. <para> If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results. </para> <para> Recently terminated instances might appear in the returned results. This interval is usually less than one hour. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>architecture</code> - The instance architecture (<code>i386</code> | <code>x86_64</code>). </para> </li> <li> <para> <code>availability-zone</code> - The Availability Zone of the instance. </para> </li> <li> <para> <code>block-device-mapping.attach-time</code> - The attach time for an EBS volume mapped to the instance, for example, <code>2010-09-15T17:15:20.000Z</code>. </para> </li> <li> <para> <code>block-device-mapping.delete-on-termination</code> - A Boolean that indicates whether the EBS volume is deleted on instance termination. </para> </li> <li> <para> <code>block-device-mapping.device-name</code> - The device name for the EBS volume (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </li> <li> <para> <code>block-device-mapping.status</code> - The status for the EBS volume (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>). </para> </li> <li> <para> <code>block-device-mapping.volume-id</code> - The volume ID of the EBS volume. </para> </li> <li> <para> <code>client-token</code> - The idempotency token you provided when you launched the instance. </para> </li> <li> <para> <code>dns-name</code> - The public DNS name of the instance. </para> </li> <li> <para> <code>group-id</code> - The ID of the security group for the instance. EC2-Classic only. </para> </li> <li> <para> <code>group-name</code> - The name of the security group for the instance. EC2-Classic only. </para> </li> <li> <para> <code>hypervisor</code> - The hypervisor type of the instance (<code>ovm</code> | <code>xen</code>). </para> </li> <li> <para> <code>iam-instance-profile.arn</code> - The instance profile associated with the instance. Specified as an ARN. </para> </li> <li> <para> <code>image-id</code> - The ID of the image used to launch the instance. </para> </li> <li> <para> <code>instance-id</code> - The ID of the instance. </para> </li> <li> <para> <code>instance-lifecycle</code> - Indicates whether this is a Spot Instance (<code>spot</code>). </para> </li> <li> <para> <code>instance-state-code</code> - The state of the instance, as 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. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). </para> </li> <li> <para> <code>instance-state-name</code> - The state of the instance (<code>pending</code> | <code>running</code> | <code>shutting-down</code> | <code>terminated</code> | <code>stopping</code> | <code>stopped</code>). </para> </li> <li> <para> <code>instance-type</code> - The type of instance (for example, <code>t2.micro</code>). </para> </li> <li> <para> <code>instance.group-id</code> - The ID of the security group for the instance. </para> </li> <li> <para> <code>instance.group-name</code> - The name of the security group for the instance. </para> </li> <li> <para> <code>ip-address</code> - The public IP address of the instance. </para> </li> <li> <para> <code>kernel-id</code> - The kernel ID. </para> </li> <li> <para> <code>key-name</code> - The name of the key pair used when the instance was launched. </para> </li> <li> <para> <code>launch-index</code> - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). </para> </li> <li> <para> <code>launch-time</code> - The time when the instance was launched. </para> </li> <li> <para> <code>monitoring-state</code> - Indicates whether monitoring is enabled for the instance (<code>disabled</code> | <code>enabled</code>). </para> </li> <li> <para> <code>owner-id</code> - The AWS account ID of the instance owner. </para> </li> <li> <para> <code>placement-group-name</code> - The name of the placement group for the instance. </para> </li> <li> <para> <code>platform</code> - The platform. Use <code>windows</code> if you have Windows instances; otherwise, leave blank. </para> </li> <li> <para> <code>private-dns-name</code> - The private DNS name of the instance. </para> </li> <li> <para> <code>private-ip-address</code> - The private IP address of the instance. </para> </li> <li> <para> <code>product-code</code> - The product code associated with the AMI used to launch the instance. </para> </li> <li> <para> <code>product-code.type</code> - The type of product code (<code>devpay</code> | <code>marketplace</code>). </para> </li> <li> <para> <code>ramdisk-id</code> - The RAM disk ID. </para> </li> <li> <para> <code>reason</code> - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. </para> </li> <li> <para> <code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). </para> </li> <li> <para> <code>reservation-id</code> - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID. </para> </li> <li> <para> <code>root-device-name</code> - The name of the root device for the instance (for example, <code>/dev/sda1</code> or <code>/dev/xvda</code>). </para> </li> <li> <para> <code>root-device-type</code> - The type of root device that the instance uses (<code>ebs</code> | <code>instance-store</code>). </para> </li> <li> <para> <code>source-dest-check</code> - Indicates whether the instance performs source/destination checking. A value of <code>true</code> means that checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the instance to perform network address translation (NAT) in your VPC. </para> </li> <li> <para> <code>spot-instance-request-id</code> - The ID of the Spot Instance request. </para> </li> <li> <para> <code>state-reason-code</code> - The reason code for the state change. </para> </li> <li> <para> <code>state-reason-message</code> - A message that describes the state change. </para> </li> <li> <para> <code>subnet-id</code> - The ID of the subnet for the instance. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource, where <code>tag</code>:<i>key</i> is the tag's key. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>tenancy</code> - The tenancy of an instance (<code>dedicated</code> | <code>default</code>). </para> </li> <li> <para> <code>virtualization-type</code> - The virtualization type of the instance (<code>paravirtual</code> | <code>hvm</code>). </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC that the instance is running in. </para> </li> <li> <para> <code>network-interface.description</code> - The description of the network interface. </para> </li> <li> <para> <code>network-interface.subnet-id</code> - The ID of the subnet for the network interface. </para> </li> <li> <para> <code>network-interface.vpc-id</code> - The ID of the VPC for the network interface. </para> </li> <li> <para> <code>network-interface.network-interface.id</code> - The ID of the network interface. </para> </li> <li> <para> <code>network-interface.owner-id</code> - The ID of the owner of the network interface. </para> </li> <li> <para> <code>network-interface.availability-zone</code> - The Availability Zone for the network interface. </para> </li> <li> <para> <code>network-interface.requester-id</code> - The requester ID for the network interface. </para> </li> <li> <para> <code>network-interface.requester-managed</code> - Indicates whether the network interface is being managed by AWS. </para> </li> <li> <para> <code>network-interface.status</code> - The status of the network interface (<code>available</code>) | <code>in-use</code>). </para> </li> <li> <para> <code>network-interface.mac-address</code> - The MAC address of the network interface. </para> </li> <li> <para> <code>network-interface-private-dns-name</code> - The private DNS name of the network interface. </para> </li> <li> <para> <code>network-interface.source-dest-check</code> - Whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform network address translation (NAT) in your VPC. </para> </li> <li> <para> <code>network-interface.group-id</code> - The ID of a security group associated with the network interface. </para> </li> <li> <para> <code>network-interface.group-name</code> - The name of a security group associated with the network interface. </para> </li> <li> <para> <code>network-interface.attachment.attachment-id</code> - The ID of the interface attachment. </para> </li> <li> <para> <code>network-interface.attachment.instance-id</code> - The ID of the instance to which the network interface is attached. </para> </li> <li> <para> <code>network-interface.attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached. </para> </li> <li> <para> <code>network-interface.addresses.private-ip-address</code> - The private IP address associated with the network interface. </para> </li> <li> <para> <code>network-interface.attachment.device-index</code> - The device index to which the network interface is attached. </para> </li> <li> <para> <code>network-interface.attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>). </para> </li> <li> <para> <code>network-interface.attachment.attach-time</code> - The time that the network interface was attached to an instance. </para> </li> <li> <para> <code>network-interface.attachment.delete-on-termination</code> - Specifies whether the attachment is deleted when an instance is terminated. </para> </li> <li> <para> <code>network-interface.addresses.primary</code> - Specifies whether the IP address of the network interface is the primary private IP address. </para> </li> <li> <para> <code>network-interface.addresses.association.public-ip</code> - The ID of the association of an Elastic IP address with a network interface. </para> </li> <li> <para> <code>network-interface.addresses.association.ip-owner-id</code> - The owner ID of the private IP address associated with the network interface. </para> </li> <li> <para> <code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface. </para> </li> <li> <para> <code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface. </para> </li> <li> <para> <code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface. </para> </li> <li> <para> <code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> <para> Default: Describes all your instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to request the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesResponse"> <summary> Configuration for accessing Amazon DescribeInstances service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResult.Reservations"> <summary> Gets and sets the property Reservations. <para> One or more reservations. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstancesResponse.DescribeInstancesResult"> <summary> Gets and sets the DescribeInstancesResult property. Represents the output of a DescribeInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusRequest"> <summary> Container for the parameters to the DescribeInstanceStatus operation. Describes the status of one or more instances. <para> Instance status includes the following components: </para> <ul> <li> <para> <b>Status checks</b> - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html">Status Checks for Your Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Scheduled events</b> - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html">Scheduled Events for Your Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> <li> <para> <b>Instance state</b> - You can manage your instances from the moment you launch them through their termination. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availability-zone</code> - The Availability Zone of the instance. </para> </li> <li> <para> <code>event.code</code> - The code for the scheduled event (<code>instance-reboot</code> | <code>system-reboot</code> | <code>system-maintenance</code> | <code>instance-retirement</code> | <code>instance-stop</code>). </para> </li> <li> <para> <code>event.description</code> - A description of the event. </para> </li> <li> <para> <code>event.not-after</code> - The latest end time for the scheduled event (for example, <code>2014-09-15T17:15:20.000Z</code>). </para> </li> <li> <para> <code>event.not-before</code> - The earliest start time for the scheduled event (for example, <code>2014-09-15T17:15:20.000Z</code>). </para> </li> <li> <para> <code>instance-state-code</code> - The code for the instance state, as 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. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). </para> </li> <li> <para> <code>instance-state-name</code> - The state of the instance (<code>pending</code> | <code>running</code> | <code>shutting-down</code> | <code>terminated</code> | <code>stopping</code> | <code>stopped</code>). </para> </li> <li> <para> <code>instance-status.reachability</code> - Filters on instance status where the name is <code>reachability</code> (<code>passed</code> | <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>). </para> </li> <li> <para> <code>instance-status.status</code> - The status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> | <code>insufficient-data</code> | <code>not-applicable</code>). </para> </li> <li> <para> <code>system-status.reachability</code> - Filters on system status where the name is <code>reachability</code> (<code>passed</code> | <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>). </para> </li> <li> <para> <code>system-status.status</code> - The system status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> | <code>insufficient-data</code> | <code>not-applicable</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.IncludeAllInstances"> <summary> Gets and sets the property IncludeAllInstances. <para> When <code>true</code>, includes the health status for all instances. When <code>false</code>, includes the health status for running instances only. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> <para> Default: Describes all your instances. </para> <para> Constraints: Maximum 100 explicitly specified instance IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusResponse"> <summary> Configuration for accessing Amazon DescribeInstanceStatus service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInstanceStatusResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResult.InstanceStatuses"> <summary> Gets and sets the property InstanceStatuses. <para> One or more instance status descriptions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInstanceStatusResponse.DescribeInstanceStatusResult"> <summary> Gets and sets the DescribeInstanceStatusResult property. Represents the output of a DescribeInstanceStatus operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysRequest"> <summary> Container for the parameters to the DescribeInternetGateways operation. Describes one or more of your Internet gateways. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached. </para> </li> <li> <para> <code>attachment.vpc-id</code> - The ID of an attached VPC. </para> </li> <li> <para> <code>internet-gateway-id</code> - The ID of the Internet gateway. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysRequest.InternetGatewayIds"> <summary> Gets and sets the property InternetGatewayIds. <para> One or more Internet gateway IDs. </para> <para> Default: Describes all your Internet gateways. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysResponse"> <summary> Configuration for accessing Amazon DescribeInternetGateways service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeInternetGatewaysResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysResult.InternetGateways"> <summary> Gets and sets the property InternetGateways. <para> Information about one or more Internet gateways. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeInternetGatewaysResponse.DescribeInternetGatewaysResult"> <summary> Gets and sets the DescribeInternetGatewaysResult property. Represents the output of a DescribeInternetGateways operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsRequest"> <summary> Container for the parameters to the DescribeKeyPairs operation. Describes one or more of your key pairs. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>fingerprint</code> - The fingerprint of the key pair. </para> </li> <li> <para> <code>key-name</code> - The name of the key pair. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsRequest.KeyNames"> <summary> Gets and sets the property KeyNames. <para> One or more key pair names. </para> <para> Default: Describes all your key pairs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsResponse"> <summary> Configuration for accessing Amazon DescribeKeyPairs service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeKeyPairsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsResult.KeyPairs"> <summary> Gets and sets the property KeyPairs. <para> Information about one or more key pairs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeKeyPairsResponse.DescribeKeyPairsResult"> <summary> Gets and sets the DescribeKeyPairsResult property. Represents the output of a DescribeKeyPairs operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeMovingAddressesRequest"> <summary> Container for the parameters to the DescribeMovingAddresses operation. Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>moving-status</code> - The status of the Elastic IP address (<code>MovingToVpc</code> | <code>RestoringToClassic</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value outside of this range, an error is returned. </para> <para> Default: If no value is provided, the default is 1000. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesRequest.PublicIps"> <summary> Gets and sets the property PublicIps. <para> One or more Elastic IP addresses. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeMovingAddressesResponse"> <summary> Configuration for accessing Amazon DescribeMovingAddresses service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeMovingAddressesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesResult.MovingAddressStatuses"> <summary> Gets and sets the property MovingAddressStatuses. <para> The status for each Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeMovingAddressesResponse.DescribeMovingAddressesResult"> <summary> Gets and sets the DescribeMovingAddressesResult property. Represents the output of a DescribeMovingAddresses operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsRequest"> <summary> Container for the parameters to the DescribeNetworkAcls operation. Describes one or more of your network ACLs. <para> For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>association.association-id</code> - The ID of an association ID for the ACL. </para> </li> <li> <para> <code>association.network-acl-id</code> - The ID of the network ACL involved in the association. </para> </li> <li> <para> <code>association.subnet-id</code> - The ID of the subnet involved in the association. </para> </li> <li> <para> <code>default</code> - Indicates whether the ACL is the default network ACL for the VPC. </para> </li> <li> <para> <code>entry.cidr</code> - The CIDR range specified in the entry. </para> </li> <li> <para> <code>entry.egress</code> - Indicates whether the entry applies to egress traffic. </para> </li> <li> <para> <code>entry.icmp.code</code> - The ICMP code specified in the entry, if any. </para> </li> <li> <para> <code>entry.icmp.type</code> - The ICMP type specified in the entry, if any. </para> </li> <li> <para> <code>entry.port-range.from</code> - The start of the port range specified in the entry. </para> </li> <li> <para> <code>entry.port-range.to</code> - The end of the port range specified in the entry. </para> </li> <li> <para> <code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number). </para> </li> <li> <para> <code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>). </para> </li> <li> <para> <code>entry.rule-number</code> - The number of an entry (in other words, rule) in the ACL's set of entries. </para> </li> <li> <para> <code>network-acl-id</code> - The ID of the network ACL. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC for the network ACL. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsRequest.NetworkAclIds"> <summary> Gets and sets the property NetworkAclIds. <para> One or more network ACL IDs. </para> <para> Default: Describes all your network ACLs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsResponse"> <summary> Configuration for accessing Amazon DescribeNetworkAcls service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkAclsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsResult.NetworkAcls"> <summary> Gets and sets the property NetworkAcls. <para> Information about one or more network ACLs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkAclsResponse.DescribeNetworkAclsResult"> <summary> Gets and sets the DescribeNetworkAclsResult property. Represents the output of a DescribeNetworkAcls operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest"> <summary> Container for the parameters to the DescribeNetworkInterfaceAttribute operation. Describes a network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The attribute of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse"> <summary> Configuration for accessing Amazon DescribeNetworkInterfaceAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.Attachment"> <summary> Gets and sets the property Attachment. <para> The attachment (if any) of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.Description"> <summary> Gets and sets the property Description. <para> The description of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.Groups"> <summary> Gets and sets the property Groups. <para> The security groups associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResult.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Indicates whether source/destination checking is enabled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfaceAttributeResponse.DescribeNetworkInterfaceAttributeResult"> <summary> Gets and sets the DescribeNetworkInterfaceAttributeResult property. Represents the output of a DescribeNetworkInterfaceAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesRequest"> <summary> Container for the parameters to the DescribeNetworkInterfaces operation. Describes one or more of your network interfaces. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>addresses.private-ip-address</code> - The private IP addresses associated with the network interface. </para> </li> <li> <para> <code>addresses.primary</code> - Whether the private IP address is the primary IP address associated with the network interface. </para> </li> <li> <para> <code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address. </para> </li> <li> <para> <code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface. </para> </li> <li> <para> <code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address. </para> </li> <li> <para> <code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface. </para> </li> <li> <para> <code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface. </para> </li> <li> <para> <code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface. </para> </li> <li> <para> <code>association.public-dns-name</code> - The public DNS name for the network interface. </para> </li> <li> <para> <code>attachment.attachment-id</code> - The ID of the interface attachment. </para> </li> <li> <para> <code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached. </para> </li> <li> <para> <code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached. </para> </li> <li> <para> <code>attachment.device-index</code> - The device index to which the network interface is attached. </para> </li> <li> <para> <code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>). </para> </li> <li> <para> <code>attachment.attach.time</code> - The time that the network interface was attached to an instance. </para> </li> <li> <para> <code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated. </para> </li> <li> <para> <code>availability-zone</code> - The Availability Zone of the network interface. </para> </li> <li> <para> <code>description</code> - The description of the network interface. </para> </li> <li> <para> <code>group-id</code> - The ID of a security group associated with the network interface. </para> </li> <li> <para> <code>group-name</code> - The name of a security group associated with the network interface. </para> </li> <li> <para> <code>mac-address</code> - The MAC address of the network interface. </para> </li> <li> <para> <code>network-interface-id</code> - The ID of the network interface. </para> </li> <li> <para> <code>owner-id</code> - The AWS account ID of the network interface owner. </para> </li> <li> <para> <code>private-ip-address</code> - The private IP address or addresses of the network interface. </para> </li> <li> <para> <code>private-dns-name</code> - The private DNS name of the network interface. </para> </li> <li> <para> <code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). </para> </li> <li> <para> <code>requester-managed</code> - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on). </para> </li> <li> <para> <code>source-desk-check</code> - Indicates whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform Network Address Translation (NAT) in your VPC. </para> </li> <li> <para> <code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; if a network interface is attached to an instance the status is <code>in-use</code>. </para> </li> <li> <para> <code>subnet-id</code> - The ID of the subnet for the network interface. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC for the network interface. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesRequest.NetworkInterfaceIds"> <summary> Gets and sets the property NetworkInterfaceIds. <para> One or more network interface IDs. </para> <para> Default: Describes all your network interfaces. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesResponse"> <summary> Configuration for accessing Amazon DescribeNetworkInterfaces service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeNetworkInterfacesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesResult.NetworkInterfaces"> <summary> Gets and sets the property NetworkInterfaces. <para> Information about one or more network interfaces. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeNetworkInterfacesResponse.DescribeNetworkInterfacesResult"> <summary> Gets and sets the DescribeNetworkInterfacesResult property. Represents the output of a DescribeNetworkInterfaces operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribePlacementGroupsRequest"> <summary> Container for the parameters to the DescribePlacementGroups operation. Describes one or more of your placement groups. For more information about placement groups and cluster instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html">Cluster Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>group-name</code> - The name of the placement group. </para> </li> <li> <para> <code>state</code> - The state of the placement group (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>). </para> </li> <li> <para> <code>strategy</code> - The strategy of the placement group (<code>cluster</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsRequest.GroupNames"> <summary> Gets and sets the property GroupNames. <para> One or more placement group names. </para> <para> Default: Describes all your placement groups, or only those otherwise specified. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribePlacementGroupsResponse"> <summary> Configuration for accessing Amazon DescribePlacementGroups service </summary> </member> <member name="T:Amazon.EC2.Model.DescribePlacementGroupsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsResult.PlacementGroups"> <summary> Gets and sets the property PlacementGroups. <para> One or more placement groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePlacementGroupsResponse.DescribePlacementGroupsResult"> <summary> Gets and sets the DescribePlacementGroupsResult property. Represents the output of a DescribePlacementGroups operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribePrefixListsRequest"> <summary> Container for the parameters to the DescribePrefixLists operation. Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint. </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>prefix-list-id</code>: The ID of a prefix list. </para> </li> <li> <para> <code>prefix-list-name</code>: The name of a prefix list. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. </para> <para> Constraint: If the value specified is greater than 1000, we return only 1000 items. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a prior call.) </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsRequest.PrefixListIds"> <summary> Gets and sets the property PrefixListIds. <para> One or more prefix list IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribePrefixListsResponse"> <summary> Configuration for accessing Amazon DescribePrefixLists service </summary> </member> <member name="T:Amazon.EC2.Model.DescribePrefixListsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsResult.PrefixLists"> <summary> Gets and sets the property PrefixLists. <para> All available prefix lists. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribePrefixListsResponse.DescribePrefixListsResult"> <summary> Gets and sets the DescribePrefixListsResult property. Represents the output of a DescribePrefixLists operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsRequest"> <summary> Container for the parameters to the DescribeRegions operation. Describes one or more regions that are currently available to you. <para> For a list of the regions supported by Amazon EC2, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region">Regions and Endpoints</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>endpoint</code> - The endpoint of the region (for example, <code>ec2.us-east-1.amazonaws.com</code>). </para> </li> <li> <para> <code>region-name</code> - The name of the region (for example, <code>us-east-1</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsRequest.RegionNames"> <summary> Gets and sets the property RegionNames. <para> The names of one or more regions. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsResponse"> <summary> Configuration for accessing Amazon DescribeRegions service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRegionsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsResult.Regions"> <summary> Gets and sets the property Regions. <para> Information about one or more regions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRegionsResponse.DescribeRegionsResult"> <summary> Gets and sets the DescribeRegionsResult property. Represents the output of a DescribeRegions operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest"> <summary> Container for the parameters to the DescribeReservedInstancesListings operation. Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. <para> The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. </para> <para> As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. </para> <para> As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>reserved-instances-id</code> - The ID of the Reserved Instances. </para> </li> <li> <para> <code>reserved-instances-listing-id</code> - The ID of the Reserved Instances listing. </para> </li> <li> <para> <code>status</code> - The status of the Reserved Instance listing (<code>pending</code> | <code>active</code> | <code>cancelled</code> | <code>closed</code>). </para> </li> <li> <para> <code>status-message</code> - The reason for the status. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> One or more Reserved Instance IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsRequest.ReservedInstancesListingId"> <summary> Gets and sets the property ReservedInstancesListingId. <para> One or more Reserved Instance Listing IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse"> <summary> Configuration for accessing Amazon DescribeReservedInstancesListings service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesListingsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsResult.ReservedInstancesListings"> <summary> Gets and sets the property ReservedInstancesListings. <para> Information about the Reserved Instance listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesListingsResponse.DescribeReservedInstancesListingsResult"> <summary> Gets and sets the DescribeReservedInstancesListingsResult property. Represents the output of a DescribeReservedInstancesListings operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest"> <summary> Container for the parameters to the DescribeReservedInstancesModifications operation. Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>client-token</code> - The idempotency token for the modification request. </para> </li> <li> <para> <code>create-date</code> - The time when the modification request was created. </para> </li> <li> <para> <code>effective-date</code> - The time when the modification becomes effective. </para> </li> <li> <para> <code>modification-result.reserved-instances-id</code> - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is <code>fulfilled</code>. </para> </li> <li> <para> <code>modification-result.target-configuration.availability-zone</code> - The Availability Zone for the new Reserved Instances. </para> </li> <li> <para> <code>modification-result.target-configuration.instance-count </code> - The number of new Reserved Instances. </para> </li> <li> <para> <code>modification-result.target-configuration.instance-type</code> - The instance type of the new Reserved Instances. </para> </li> <li> <para> <code>modification-result.target-configuration.platform</code> - The network platform of the new Reserved Instances (<code>EC2-Classic</code> | <code>EC2-VPC</code>). </para> </li> <li> <para> <code>reserved-instances-id</code> - The ID of the Reserved Instances modified. </para> </li> <li> <para> <code>reserved-instances-modification-id</code> - The ID of the modification request. </para> </li> <li> <para> <code>status</code> - The status of the Reserved Instances modification request (<code>processing</code> | <code>fulfilled</code> | <code>failed</code>). </para> </li> <li> <para> <code>status-message</code> - The reason for the status. </para> </li> <li> <para> <code>update-date</code> - The time when the modification request was last updated. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsRequest.ReservedInstancesModificationIds"> <summary> Gets and sets the property ReservedInstancesModificationIds. <para> IDs for the submitted modification request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse"> <summary> Configuration for accessing Amazon DescribeReservedInstancesModifications service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResult.ReservedInstancesModifications"> <summary> Gets and sets the property ReservedInstancesModifications. <para> The Reserved Instance modification information. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesModificationsResponse.DescribeReservedInstancesModificationsResult"> <summary> Gets and sets the DescribeReservedInstancesModificationsResult property. Represents the output of a DescribeReservedInstancesModifications operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest"> <summary> Container for the parameters to the DescribeReservedInstancesOfferings operation. Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which the Reserved Instance can be used. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used. </para> </li> <li> <para> <code>duration</code> - The duration of the Reserved Instance (for example, one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>). </para> </li> <li> <para> <code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0). </para> </li> <li> <para> <code>instance-type</code> - The instance type on which the Reserved Instance can be used. </para> </li> <li> <para> <code>marketplace</code> - Set to <code>true</code> to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed. </para> </li> <li> <para> <code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code> Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>) </para> </li> <li> <para> <code>reserved-instances-offering-id</code> - The Reserved Instances offering ID. </para> </li> <li> <para> <code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.IncludeMarketplace"> <summary> Gets and sets the property IncludeMarketplace. <para> Include Marketplace offerings in the response. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.InstanceTenancy"> <summary> Gets and sets the property InstanceTenancy. <para> The tenancy of the Reserved Instance offering. A Reserved Instance with <code>dedicated</code> tenancy runs on single-tenant hardware and can only be launched within a VPC. </para> <para> Default: <code>default</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type on which the Reserved Instance can be used. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxDuration"> <summary> Gets and sets the property MaxDuration. <para> The maximum duration (in seconds) to filter when searching for offerings. </para> <para> Default: 94608000 (3 years) </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxInstanceCount"> <summary> Gets and sets the property MaxInstanceCount. <para> The maximum number of instances to filter when searching for offerings. </para> <para> Default: 20 </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. The maximum is 100. </para> <para> Default: 100 </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.MinDuration"> <summary> Gets and sets the property MinDuration. <para> The minimum duration (in seconds) to filter when searching for offerings. </para> <para> Default: 2592000 (1 month) </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.OfferingType"> <summary> Gets and sets the property OfferingType. <para> The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.ProductDescription"> <summary> Gets and sets the property ProductDescription. <para> The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the description are for use with Amazon VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsRequest.ReservedInstancesOfferingIds"> <summary> Gets and sets the property ReservedInstancesOfferingIds. <para> One or more Reserved Instances offering IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse"> <summary> Configuration for accessing Amazon DescribeReservedInstancesOfferings service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResult.ReservedInstancesOfferings"> <summary> Gets and sets the property ReservedInstancesOfferings. <para> A list of Reserved Instances offerings. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse.DescribeReservedInstancesOfferingsResult"> <summary> Gets and sets the DescribeReservedInstancesOfferingsResult property. Represents the output of a DescribeReservedInstancesOfferings operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesRequest"> <summary> Container for the parameters to the DescribeReservedInstances operation. Describes one or more of the Reserved Instances that you purchased. <para> For more information about Reserved Instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used. </para> </li> <li> <para> <code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>). </para> </li> <li> <para> <code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). </para> </li> <li> <para> <code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0). </para> </li> <li> <para> <code>instance-type</code> - The instance type on which the Reserved Instance can be used. </para> </li> <li> <para> <code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>). </para> </li> <li> <para> <code>reserved-instances-id</code> - The ID of the Reserved Instance. </para> </li> <li> <para> <code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). </para> </li> <li> <para> <code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.OfferingType"> <summary> Gets and sets the property OfferingType. <para> The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the <code>Medium Utilization</code> Reserved Instance offering type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesRequest.ReservedInstancesIds"> <summary> Gets and sets the property ReservedInstancesIds. <para> One or more Reserved Instance IDs. </para> <para> Default: Describes all your Reserved Instances, or only those otherwise specified. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesResponse"> <summary> Configuration for accessing Amazon DescribeReservedInstances service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeReservedInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesResult.ReservedInstances"> <summary> Gets and sets the property ReservedInstances. <para> A list of Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeReservedInstancesResponse.DescribeReservedInstancesResult"> <summary> Gets and sets the DescribeReservedInstancesResult property. Represents the output of a DescribeReservedInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesRequest"> <summary> Container for the parameters to the DescribeRouteTables operation. Describes one or more of your route tables. <para> Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. </para> <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>association.route-table-association-id</code> - The ID of an association ID for the route table. </para> </li> <li> <para> <code>association.route-table-id</code> - The ID of the route table involved in the association. </para> </li> <li> <para> <code>association.subnet-id</code> - The ID of the subnet involved in the association. </para> </li> <li> <para> <code>association.main</code> - Indicates whether the route table is the main route table for the VPC. </para> </li> <li> <para> <code>route-table-id</code> - The ID of the route table. </para> </li> <li> <para> <code>route.destination-cidr-block</code> - The CIDR range specified in a route in the table. </para> </li> <li> <para> <code>route.destination-prefix-list-id</code> - The ID (prefix) of the AWS service specified in a route in the table. </para> </li> <li> <para> <code>route.gateway-id</code> - The ID of a gateway specified in a route in the table. </para> </li> <li> <para> <code>route.instance-id</code> - The ID of an instance specified in a route in the table. </para> </li> <li> <para> <code>route.origin</code> - Describes how the route was created. <code>CreateRouteTable</code> indicates that the route was automatically created when the route table was created; <code>CreateRoute</code> indicates that the route was manually added to the route table; <code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation. </para> </li> <li> <para> <code>route.state</code> - The state of a route in the route table (<code>active</code> | <code>blackhole</code>). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). </para> </li> <li> <para> <code>route.vpc-peering-connection-id</code> - The ID of a VPC peering connection specified in a route in the table. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC for the route table. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesRequest.RouteTableIds"> <summary> Gets and sets the property RouteTableIds. <para> One or more route table IDs. </para> <para> Default: Describes all your route tables. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesResponse"> <summary> Configuration for accessing Amazon DescribeRouteTables service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeRouteTablesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesResult.RouteTables"> <summary> Gets and sets the property RouteTables. <para> Information about one or more route tables. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeRouteTablesResponse.DescribeRouteTablesResult"> <summary> Gets and sets the DescribeRouteTablesResult property. Represents the output of a DescribeRouteTables operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsRequest"> <summary> Container for the parameters to the DescribeSecurityGroups operation. Describes one or more of your security groups. <para> A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters. </para> <ul> <li> <para> <code>description</code> - The description of the security group. </para> </li> <li> <para> <code>egress.ip-permission.prefix-list-id</code> - The ID (prefix) of the AWS service to which the security group allows access. </para> </li> <li> <para> <code>group-id</code> - The ID of the security group. </para> </li> <li> <para> <code>group-name</code> - The name of the security group. </para> </li> <li> <para> <code>ip-permission.cidr</code> - A CIDR range that has been granted permission. </para> </li> <li> <para> <code>ip-permission.from-port</code> - The start of port range for the TCP and UDP protocols, or an ICMP type number. </para> </li> <li> <para> <code>ip-permission.group-id</code> - The ID of a security group that has been granted permission. </para> </li> <li> <para> <code>ip-permission.group-name</code> - The name of a security group that has been granted permission. </para> </li> <li> <para> <code>ip-permission.protocol</code> - The IP protocol for the permission (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number). </para> </li> <li> <para> <code>ip-permission.to-port</code> - The end of port range for the TCP and UDP protocols, or an ICMP code. </para> </li> <li> <para> <code>ip-permission.user-id</code> - The ID of an AWS account that has been granted permission. </para> </li> <li> <para> <code>owner-id</code> - The AWS account ID of the owner of the security group. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the security group. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the security group. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC specified when the security group was created. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.GroupIds"> <summary> Gets and sets the property GroupIds. <para> One or more security group IDs. Required for security groups in a nondefault VPC. </para> <para> Default: Describes all your security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsRequest.GroupNames"> <summary> Gets and sets the property GroupNames. <para> [EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the <code>group-name</code> filter to describe security groups by name. </para> <para> Default: Describes all your security groups. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsResponse"> <summary> Configuration for accessing Amazon DescribeSecurityGroups service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSecurityGroupsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsResult.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> Information about one or more security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSecurityGroupsResponse.DescribeSecurityGroupsResult"> <summary> Gets and sets the DescribeSecurityGroupsResult property. Represents the output of a DescribeSecurityGroups operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeRequest"> <summary> Container for the parameters to the DescribeSnapshotAttribute operation. Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.#ctor(System.String,Amazon.EC2.SnapshotAttributeName)"> <summary> Instantiates DescribeSnapshotAttributeRequest with the parameterized properties </summary> <param name="snapshotId">The ID of the EBS snapshot.</param> <param name="attribute">The snapshot attribute you would like to view.</param> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The snapshot attribute you would like to view. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the EBS snapshot. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeResponse"> <summary> Configuration for accessing Amazon DescribeSnapshotAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotAttributeResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResult.CreateVolumePermissions"> <summary> Gets and sets the property CreateVolumePermissions. <para> A list of permissions for creating volumes from the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResult.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> A list of product codes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResult.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the EBS snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotAttributeResponse.DescribeSnapshotAttributeResult"> <summary> Gets and sets the DescribeSnapshotAttributeResult property. Represents the output of a DescribeSnapshotAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsRequest"> <summary> Container for the parameters to the DescribeSnapshots operation. Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. <para> The create volume permissions fall into the following categories: </para> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <para> The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. </para> <para> If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. </para> <para> If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own. </para> <para> If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots. </para> <para> If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results. </para> <para> For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>description</code> - A description of the snapshot. </para> </li> <li> <para> <code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>) that owns the snapshot. </para> </li> <li> <para> <code>owner-id</code> - The ID of the AWS account that owns the snapshot. </para> </li> <li> <para> <code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%). </para> </li> <li> <para> <code>snapshot-id</code> - The snapshot ID. </para> </li> <li> <para> <code>start-time</code> - The time stamp when the snapshot was initiated. </para> </li> <li> <para> <code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>volume-id</code> - The ID of the volume the snapshot is for. </para> </li> <li> <para> <code>volume-size</code> - The size of the volume, in GiB. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of snapshot results returned by <code>DescribeSnapshots</code> in paginated output. When this parameter is used, <code>DescribeSnapshots</code> only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeSnapshots</code> request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeSnapshots</code> returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>NextToken</code> value returned from a previous paginated <code>DescribeSnapshots</code> request where <code>MaxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.OwnerIds"> <summary> Gets and sets the property OwnerIds. <para> Returns the snapshots owned by the specified owner. Multiple owners can be specified. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.RestorableByUserIds"> <summary> Gets and sets the property RestorableByUserIds. <para> One or more AWS accounts IDs that can create volumes from the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsRequest.SnapshotIds"> <summary> Gets and sets the property SnapshotIds. <para> One or more snapshot IDs. </para> <para> Default: Describes snapshots for which you have launch permissions. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsResponse"> <summary> Configuration for accessing Amazon DescribeSnapshots service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSnapshotsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>NextToken</code> value to include in a future <code>DescribeSnapshots</code> request. When the results of a <code>DescribeSnapshots</code> request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResult.Snapshots"> <summary> Gets and sets the property Snapshots. <para> Information about the snapshots. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSnapshotsResponse.DescribeSnapshotsResult"> <summary> Gets and sets the DescribeSnapshotsResult property. Represents the output of a DescribeSnapshots operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionRequest"> <summary> Container for the parameters to the DescribeSpotDatafeedSubscription operation. Describes the data feed for Spot instances. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse"> <summary> Configuration for accessing Amazon DescribeSpotDatafeedSubscription service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult"> <summary> Contains the output of DescribeSpotDatafeedSubscription. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResult.SpotDatafeedSubscription"> <summary> Gets and sets the property SpotDatafeedSubscription. <para> The Spot instance data feed subscription. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotDatafeedSubscriptionResponse.DescribeSpotDatafeedSubscriptionResult"> <summary> Gets and sets the DescribeSpotDatafeedSubscriptionResult property. Represents the output of a DescribeSpotDatafeedSubscription operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetInstancesRequest"> <summary> Container for the parameters to the DescribeSpotFleetInstances operation. Describes the running instances for the specified Spot fleet. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesRequest.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetInstancesResponse"> <summary> Configuration for accessing Amazon DescribeSpotFleetInstances service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetInstancesResult"> <summary> Contains the output of DescribeSpotFleetInstances. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesResult.ActiveInstances"> <summary> Gets and sets the property ActiveInstances. <para> The running instances. Note that this list is refreshed periodically and might be out of date. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesResult.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetInstancesResponse.DescribeSpotFleetInstancesResult"> <summary> Gets and sets the DescribeSpotFleetInstancesResult property. Represents the output of a DescribeSpotFleetInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest"> <summary> Container for the parameters to the DescribeSpotFleetRequestHistory operation. Describes the events for the specified Spot fleet request during the specified time. <para> Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest.EventType"> <summary> Gets and sets the property EventType. <para> The type of events to describe. By default, all events are described. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> The starting date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResponse"> <summary> Configuration for accessing Amazon DescribeSpotFleetRequestHistory service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult"> <summary> Contains the output of DescribeSpotFleetRequestHistory. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult.HistoryRecords"> <summary> Gets and sets the property HistoryRecords. <para> Information about the events in the history of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult.LastEvaluatedTime"> <summary> Gets and sets the property LastEvaluatedTime. <para> The last date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). All records up to this time were retrieved. </para> <para> If <code>nextToken</code> indicates that there are more results, this value is not present. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResult.StartTime"> <summary> Gets and sets the property StartTime. <para> The starting date and time for the events, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestHistoryResponse.DescribeSpotFleetRequestHistoryResult"> <summary> Gets and sets the DescribeSpotFleetRequestHistoryResult property. Represents the output of a DescribeSpotFleetRequestHistory operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestsRequest"> <summary> Container for the parameters to the DescribeSpotFleetRequests operation. Describes your Spot fleet requests. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsRequest.SpotFleetRequestIds"> <summary> Gets and sets the property SpotFleetRequestIds. <para> The IDs of the Spot fleet requests. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestsResponse"> <summary> Configuration for accessing Amazon DescribeSpotFleetRequests service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotFleetRequestsResult"> <summary> Contains the output of DescribeSpotFleetRequests. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsResult.SpotFleetRequestConfigs"> <summary> Gets and sets the property SpotFleetRequestConfigs. <para> Information about the configuration of your Spot fleet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotFleetRequestsResponse.DescribeSpotFleetRequestsResult"> <summary> Gets and sets the DescribeSpotFleetRequestsResult property. Represents the output of a DescribeSpotFleetRequests operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest"> <summary> Container for the parameters to the DescribeSpotInstanceRequests operation. Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availability-zone-group</code> - The Availability Zone group. </para> </li> <li> <para> <code>create-time</code> - The time stamp when the Spot instance request was created. </para> </li> <li> <para> <code>fault-code</code> - The fault code related to the request. </para> </li> <li> <para> <code>fault-message</code> - The fault message related to the request. </para> </li> <li> <para> <code>instance-id</code> - The ID of the instance that fulfilled the request. </para> </li> <li> <para> <code>launch-group</code> - The Spot instance launch group. </para> </li> <li> <para> <code>launch.block-device-mapping.delete-on-termination</code> - Indicates whether the Amazon EBS volume is deleted on instance termination. </para> </li> <li> <para> <code>launch.block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>). </para> </li> <li> <para> <code>launch.block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume. </para> </li> <li> <para> <code>launch.block-device-mapping.volume-size</code> - The size of the Amazon EBS volume, in GiB. </para> </li> <li> <para> <code>launch.block-device-mapping.volume-type</code> - The type of the Amazon EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>). </para> </li> <li> <para> <code>launch.group-id</code> - The security group for the instance. </para> </li> <li> <para> <code>launch.image-id</code> - The ID of the AMI. </para> </li> <li> <para> <code>launch.instance-type</code> - The type of instance (for example, <code>m1.small</code>). </para> </li> <li> <para> <code>launch.kernel-id</code> - The kernel ID. </para> </li> <li> <para> <code>launch.key-name</code> - The name of the key pair the instance launched with. </para> </li> <li> <para> <code>launch.monitoring-enabled</code> - Whether monitoring is enabled for the Spot instance. </para> </li> <li> <para> <code>launch.ramdisk-id</code> - The RAM disk ID. </para> </li> <li> <para> <code>network-interface.network-interface-id</code> - The ID of the network interface. </para> </li> <li> <para> <code>network-interface.device-index</code> - The index of the device for the network interface attachment on the instance. </para> </li> <li> <para> <code>network-interface.subnet-id</code> - The ID of the subnet for the instance. </para> </li> <li> <para> <code>network-interface.description</code> - A description of the network interface. </para> </li> <li> <para> <code>network-interface.private-ip-address</code> - The primary private IP address of the network interface. </para> </li> <li> <para> <code>network-interface.delete-on-termination</code> - Indicates whether the network interface is deleted when the instance is terminated. </para> </li> <li> <para> <code>network-interface.group-id</code> - The ID of the security group associated with the network interface. </para> </li> <li> <para> <code>network-interface.group-name</code> - The name of the security group associated with the network interface. </para> </li> <li> <para> <code>network-interface.addresses.primary</code> - Indicates whether the IP address is the primary private IP address. </para> </li> <li> <para> <code>product-description</code> - The product description associated with the instance (<code>Linux/UNIX</code> | <code>Windows</code>). </para> </li> <li> <para> <code>spot-instance-request-id</code> - The Spot instance request ID. </para> </li> <li> <para> <code>spot-price</code> - The maximum hourly price for any Spot instance launched to fulfill the request. </para> </li> <li> <para> <code>state</code> - The state of the Spot instance request (<code>open</code> | <code>active</code> | <code>closed</code> | <code>cancelled</code> | <code>failed</code>). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html">Spot Bid Status</a> in the Amazon Elastic Compute Cloud User Guide. </para> </li> <li> <para> <code>status-code</code> - The short code describing the most recent evaluation of your Spot instance request. </para> </li> <li> <para> <code>status-message</code> - The message explaining the status of the Spot instance request. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>type</code> - The type of Spot instance request (<code>one-time</code> | <code>persistent</code>). </para> </li> <li> <para> <code>launched-availability-zone</code> - The Availability Zone in which the bid is launched. </para> </li> <li> <para> <code>valid-from</code> - The start date of the request. </para> </li> <li> <para> <code>valid-until</code> - The end date of the request. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsRequest.SpotInstanceRequestIds"> <summary> Gets and sets the property SpotInstanceRequestIds. <para> One or more Spot instance request IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse"> <summary> Configuration for accessing Amazon DescribeSpotInstanceRequests service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult"> <summary> Contains the output of DescribeSpotInstanceRequests. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsResult.SpotInstanceRequests"> <summary> Gets and sets the property SpotInstanceRequests. <para> One or more Spot instance requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse.DescribeSpotInstanceRequestsResult"> <summary> Gets and sets the DescribeSpotInstanceRequestsResult property. Represents the output of a DescribeSpotInstanceRequests operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest"> <summary> Container for the parameters to the DescribeSpotPriceHistory operation. Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <para> When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> Filters the results by the specified Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availability-zone</code> - The Availability Zone for which prices should be returned. </para> </li> <li> <para> <code>instance-type</code> - The type of instance (for example, <code>m1.small</code>). </para> </li> <li> <para> <code>product-description</code> - The product description for the Spot price (<code>Linux/UNIX</code> | <code>SUSE Linux</code> | <code>Windows</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Windows (Amazon VPC)</code>). </para> </li> <li> <para> <code>spot-price</code> - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported). </para> </li> <li> <para> <code>timestamp</code> - The timestamp of the Spot price history, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.InstanceTypes"> <summary> Gets and sets the property InstanceTypes. <para> Filters the results by the specified instance types. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of results. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.ProductDescriptions"> <summary> Gets and sets the property ProductDescriptions. <para> Filters the results by the specified basic product descriptions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse"> <summary> Configuration for accessing Amazon DescribeSpotPriceHistory service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSpotPriceHistoryResult"> <summary> Contains the output of DescribeSpotPriceHistory. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResult.SpotPriceHistory"> <summary> Gets and sets the property SpotPriceHistory. <para> The historical Spot prices. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSpotPriceHistoryResponse.DescribeSpotPriceHistoryResult"> <summary> Gets and sets the DescribeSpotPriceHistoryResult property. Represents the output of a DescribeSpotPriceHistory operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsRequest"> <summary> Container for the parameters to the DescribeSubnets operation. Describes one or more of your subnets. <para> For more information about subnets, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>availabilityZone</code> - The Availability Zone for the subnet. You can also use <code>availability-zone</code> as the filter name. </para> </li> <li> <para> <code>available-ip-address-count</code> - The number of IP addresses in the subnet that are available. </para> </li> <li> <para> <code>cidrBlock</code> - 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 <code>cidr</code> or <code>cidr-block</code> as the filter names. </para> </li> <li> <para> <code>defaultForAz</code> - Indicates whether this is the default subnet for the Availability Zone. You can also use <code>default-for-az</code> as the filter name. </para> </li> <li> <para> <code>state</code> - The state of the subnet (<code>pending</code> | <code>available</code>). </para> </li> <li> <para> <code>subnet-id</code> - The ID of the subnet. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC for the subnet. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsRequest.SubnetIds"> <summary> Gets and sets the property SubnetIds. <para> One or more subnet IDs. </para> <para> Default: Describes all your subnets. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsResponse"> <summary> Configuration for accessing Amazon DescribeSubnets service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeSubnetsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsResult.Subnets"> <summary> Gets and sets the property Subnets. <para> Information about one or more subnets. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeSubnetsResponse.DescribeSubnetsResult"> <summary> Gets and sets the DescribeSubnetsResult property. Represents the output of a DescribeSubnets operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsRequest"> <summary> Container for the parameters to the DescribeTags operation. Describes one or more of the tags for your EC2 resources. <para> For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeTagsRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DescribeTagsRequest.#ctor(System.Collections.Generic.List{Amazon.EC2.Model.Filter})"> <summary> Instantiates DescribeTagsRequest with the parameterized properties </summary> <param name="filters">One or more filters. <ul> <li> <code>key</code> - The tag key. </li> <li> <code>resource-id</code> - The resource ID. </li> <li> <code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dhcp-options</code> | <code>image</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>). </li> <li> <code>value</code> - The tag value. </li> </ul></param> </member> <member name="P:Amazon.EC2.Model.DescribeTagsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>key</code> - The tag key. </para> </li> <li> <para> <code>resource-id</code> - The resource ID. </para> </li> <li> <para> <code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dhcp-options</code> | <code>image</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>). </para> </li> <li> <para> <code>value</code> - The tag value. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to retrieve the next page of results. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsResponse"> <summary> Configuration for accessing Amazon DescribeTags service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeTagsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResult.Tags"> <summary> Gets and sets the property Tags. <para> A list of tags. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeTagsResponse.DescribeTagsResult"> <summary> Gets and sets the DescribeTagsResult property. Represents the output of a DescribeTags operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeRequest"> <summary> Container for the parameters to the DescribeVolumeAttribute operation. Describes the specified attribute of the specified volume. You can specify only one attribute at a time. <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The instance attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeResponse"> <summary> Configuration for accessing Amazon DescribeVolumeAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeAttributeResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.AutoEnableIO"> <summary> Gets and sets the property AutoEnableIO. <para> The state of <code>autoEnableIO</code> attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> A list of product codes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResult.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeAttributeResponse.DescribeVolumeAttributeResult"> <summary> Gets and sets the DescribeVolumeAttributeResult property. Represents the output of a DescribeVolumeAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumesRequest"> <summary> Container for the parameters to the DescribeVolumes operation. Describes the specified EBS volumes. <para> If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeVolumes</code> request to retrieve the remaining results. </para> <para> For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DescribeVolumesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates DescribeVolumesRequest with the parameterized properties </summary> <param name="volumeIds">One or more volume IDs.</param> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>attachment.attach-time</code> - The time stamp when the attachment initiated. </para> </li> <li> <para> <code>attachment.delete-on-termination</code> - Whether the volume is deleted on instance termination. </para> </li> <li> <para> <code>attachment.device</code> - The device name that is exposed to the instance (for example, <code>/dev/sda1</code>). </para> </li> <li> <para> <code>attachment.instance-id</code> - The ID of the instance the volume is attached to. </para> </li> <li> <para> <code>attachment.status</code> - The attachment state (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>). </para> </li> <li> <para> <code>availability-zone</code> - The Availability Zone in which the volume was created. </para> </li> <li> <para> <code>create-time</code> - The time stamp when the volume was created. </para> </li> <li> <para> <code>encrypted</code> - The encryption status of the volume. </para> </li> <li> <para> <code>size</code> - The size of the volume, in GiB. </para> </li> <li> <para> <code>snapshot-id</code> - The snapshot from which the volume was created. </para> </li> <li> <para> <code>status</code> - The status of the volume (<code>creating</code> | <code>available</code> | <code>in-use</code> | <code>deleting</code> | <code>deleted</code> | <code>error</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>volume-id</code> - The volume ID. </para> </li> <li> <para> <code>volume-type</code> - The Amazon EBS volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of volume results returned by <code>DescribeVolumes</code> in paginated output. When this parameter is used, <code>DescribeVolumes</code> only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeVolumes</code> request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeVolumes</code> returns all results. You cannot specify this parameter and the volume IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>NextToken</code> value returned from a previous paginated <code>DescribeVolumes</code> request where <code>MaxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>NextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesRequest.VolumeIds"> <summary> Gets and sets the property VolumeIds. <para> One or more volume IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumesResponse"> <summary> Configuration for accessing Amazon DescribeVolumes service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>NextToken</code> value to include in a future <code>DescribeVolumes</code> request. When the results of a <code>DescribeVolumes</code> request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResult.Volumes"> <summary> Gets and sets the property Volumes. <para> Information about the volumes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumesResponse.DescribeVolumesResult"> <summary> Gets and sets the DescribeVolumesResult property. Represents the output of a DescribeVolumes operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusRequest"> <summary> Container for the parameters to the DescribeVolumeStatus operation. Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. <para> The <code>DescribeVolumeStatus</code> operation provides the following information about the specified volumes: </para> <para> <i>Status</i>: Reflects the current status of the volume. The possible values are <code>ok</code>, <code>impaired</code> , <code>warning</code>, or <code>insufficient-data</code>. If all checks pass, the overall status of the volume is <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the status is <code>insufficient-data</code>, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html">Monitoring the Status of Your Volumes</a>. </para> <para> <i>Events</i>: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an <code>impaired</code> status, then the volume event might be <code>potential-data-inconsistency</code>. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data. </para> <para> <i>Actions</i>: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is <code>impaired</code> and the volume event shows <code>potential-data-inconsistency</code>, then the action shows <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data consistency. </para> <note> <para> Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the <code>error</code> state (for example, when a volume is incapable of accepting I/O.) </para> </note> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>action.code</code> - The action code for the event (for example, <code>enable-volume-io</code>). </para> </li> <li> <para> <code>action.description</code> - A description of the action. </para> </li> <li> <para> <code>action.event-id</code> - The event ID associated with the action. </para> </li> <li> <para> <code>availability-zone</code> - The Availability Zone of the instance. </para> </li> <li> <para> <code>event.description</code> - A description of the event. </para> </li> <li> <para> <code>event.event-id</code> - The event ID. </para> </li> <li> <para> <code>event.event-type</code> - The event type (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>io-performance:degraded</code> | <code>io-performance:severely-degraded</code> | <code>io-performance:stalled</code>). </para> </li> <li> <para> <code>event.not-after</code> - The latest end time for the event. </para> </li> <li> <para> <code>event.not-before</code> - The earliest start time for the event. </para> </li> <li> <para> <code>volume-status.details-name</code> - The cause for <code>volume-status.status</code> (<code>io-enabled</code> | <code>io-performance</code>). </para> </li> <li> <para> <code>volume-status.details-status</code> - The status of <code>volume-status.details-name</code> (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>normal</code> | <code>degraded</code> | <code>severely-degraded</code> | <code>stalled</code>). </para> </li> <li> <para> <code>volume-status.status</code> - The status of the volume (<code>ok</code> | <code>impaired</code> | <code>warning</code> | <code>insufficient-data</code>). </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of volume results returned by <code>DescribeVolumeStatus</code> in paginated output. When this parameter is used, the request only returns <code>MaxResults</code> results in a single page along with a <code>NextToken</code> response element. The remaining results of the initial request can be seen by sending another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000; if <code>MaxResults</code> is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then <code>DescribeVolumeStatus</code> returns all results. You cannot specify this parameter and the volume IDs parameter in the same request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>NextToken</code> value to include in a future <code>DescribeVolumeStatus</code> request. When the results of the request exceed <code>MaxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusRequest.VolumeIds"> <summary> Gets and sets the property VolumeIds. <para> One or more volume IDs. </para> <para> Default: Describes all your volumes. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusResponse"> <summary> Configuration for accessing Amazon DescribeVolumeStatus service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVolumeStatusResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResult.VolumeStatuses"> <summary> Gets and sets the property VolumeStatuses. <para> A list of volumes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVolumeStatusResponse.DescribeVolumeStatusResult"> <summary> Gets and sets the DescribeVolumeStatusResult property. Represents the output of a DescribeVolumeStatus operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeRequest"> <summary> Container for the parameters to the DescribeVpcAttribute operation. Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The VPC attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeResponse"> <summary> Configuration for accessing Amazon DescribeVpcAttribute service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcAttributeResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.EnableDnsHostnames"> <summary> Gets and sets the property EnableDnsHostnames. <para> Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is <code>true</code>, instances in the VPC get DNS hostnames; otherwise, they do not. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.EnableDnsSupport"> <summary> Gets and sets the property EnableDnsSupport. <para> Indicates whether DNS resolution is enabled for the VPC. If this attribute is <code>true</code>, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResult.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcAttributeResponse.DescribeVpcAttributeResult"> <summary> Gets and sets the DescribeVpcAttributeResult property. Represents the output of a DescribeVpcAttribute operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcClassicLinkRequest"> <summary> Container for the parameters to the DescribeVpcClassicLink operation. Describes the ClassicLink status of one or more VPCs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcClassicLinkRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>is-classic-link-enabled</code> - Whether the VPC is enabled for ClassicLink (<code>true</code> | <code>false</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcClassicLinkRequest.VpcIds"> <summary> Gets and sets the property VpcIds. <para> One or more VPCs for which you want to describe the ClassicLink status. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcClassicLinkResponse"> <summary> Configuration for accessing Amazon DescribeVpcClassicLink service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcClassicLinkResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcClassicLinkResult.Vpcs"> <summary> Gets and sets the property Vpcs. <para> The ClassicLink status of one or more VPCs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcClassicLinkResponse.DescribeVpcClassicLinkResult"> <summary> Gets and sets the DescribeVpcClassicLinkResult property. Represents the output of a DescribeVpcClassicLink operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointServicesRequest"> <summary> Container for the parameters to the DescribeVpcEndpointServices operation. Describes all supported AWS services that can be specified when creating a VPC endpoint. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointServicesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. </para> <para> Constraint: If the value is greater than 1000, we return only 1000 items. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointServicesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a prior call.) </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointServicesResponse"> <summary> Configuration for accessing Amazon DescribeVpcEndpointServices service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointServicesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointServicesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointServicesResult.ServiceNames"> <summary> Gets and sets the property ServiceNames. <para> A list of supported AWS services. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointServicesResponse.DescribeVpcEndpointServicesResult"> <summary> Gets and sets the DescribeVpcEndpointServicesResult property. Represents the output of a DescribeVpcEndpointServices operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointsRequest"> <summary> Container for the parameters to the DescribeVpcEndpoints operation. Describes one or more of your VPC endpoints. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>service-name</code>: The name of the AWS service. </para> </li> <li> <para> <code>vpc-id</code>: The ID of the VPC in which the endpoint resides. </para> </li> <li> <para> <code>vpc-endpoint-id</code>: The ID of the endpoint. </para> </li> <li> <para> <code>vpc-endpoint-state</code>: The state of the endpoint. (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>) </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. </para> <para> Constraint: If the value is greater than 1000, we return only 1000 items. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The token for the next set of items to return. (You received this token from a prior call.) </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsRequest.VpcEndpointIds"> <summary> Gets and sets the property VpcEndpointIds. <para> One or more endpoint IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointsResponse"> <summary> Configuration for accessing Amazon DescribeVpcEndpoints service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcEndpointsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsResult.VpcEndpoints"> <summary> Gets and sets the property VpcEndpoints. <para> Information about the endpoints. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcEndpointsResponse.DescribeVpcEndpointsResult"> <summary> Gets and sets the DescribeVpcEndpointsResult property. Represents the output of a DescribeVpcEndpoints operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest"> <summary> Container for the parameters to the DescribeVpcPeeringConnections operation. Describes one or more of your VPC peering connections. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>accepter-vpc-info.cidr-block</code> - The CIDR block of the peer VPC. </para> </li> <li> <para> <code>accepter-vpc-info.owner-id</code> - The AWS account ID of the owner of the peer VPC. </para> </li> <li> <para> <code>accepter-vpc-info.vpc-id</code> - The ID of the peer VPC. </para> </li> <li> <para> <code>expiration-time</code> - The expiration date and time for the VPC peering connection. </para> </li> <li> <para> <code>requester-vpc-info.cidr-block</code> - The CIDR block of the requester's VPC. </para> </li> <li> <para> <code>requester-vpc-info.owner-id</code> - The AWS account ID of the owner of the requester VPC. </para> </li> <li> <para> <code>requester-vpc-info.vpc-id</code> - The ID of the requester VPC. </para> </li> <li> <para> <code>status-code</code> - The status of the VPC peering connection (<code>pending-acceptance</code> | <code>failed</code> | <code>expired</code> | <code>provisioning</code> | <code>active</code> | <code>deleted</code> | <code>rejected</code>). </para> </li> <li> <para> <code>status-message</code> - A message that provides more information about the status of the VPC peering connection, if applicable. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-peering-connection-id</code> - The ID of the VPC peering connection. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsRequest.VpcPeeringConnectionIds"> <summary> Gets and sets the property VpcPeeringConnectionIds. <para> One or more VPC peering connection IDs. </para> <para> Default: Describes all your VPC peering connections. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse"> <summary> Configuration for accessing Amazon DescribeVpcPeeringConnections service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResult.VpcPeeringConnections"> <summary> Gets and sets the property VpcPeeringConnections. <para> Information about the VPC peering connections. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcPeeringConnectionsResponse.DescribeVpcPeeringConnectionsResult"> <summary> Gets and sets the DescribeVpcPeeringConnectionsResult property. Represents the output of a DescribeVpcPeeringConnections operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsRequest"> <summary> Container for the parameters to the DescribeVpcs operation. Describes one or more of your VPCs. </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>cidr</code> - 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. Must contain the slash followed by one or two digits (for example, <code>/28</code>). </para> </li> <li> <para> <code>dhcp-options-id</code> - The ID of a set of DHCP options. </para> </li> <li> <para> <code>isDefault</code> - Indicates whether the VPC is the default VPC. </para> </li> <li> <para> <code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>vpc-id</code> - The ID of the VPC. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsRequest.VpcIds"> <summary> Gets and sets the property VpcIds. <para> One or more VPC IDs. </para> <para> Default: Describes all your VPCs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsResponse"> <summary> Configuration for accessing Amazon DescribeVpcs service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpcsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsResult.Vpcs"> <summary> Gets and sets the property Vpcs. <para> Information about one or more VPCs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpcsResponse.DescribeVpcsResult"> <summary> Gets and sets the DescribeVpcsResult property. Represents the output of a DescribeVpcs operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsRequest"> <summary> Container for the parameters to the DescribeVpnConnections operation. Describes one or more of your VPN connections. <para> For more information about VPN connections, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding a Hardware Virtual Private Gateway to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>customer-gateway-configuration</code> - The configuration information for the customer gateway. </para> </li> <li> <para> <code>customer-gateway-id</code> - The ID of a customer gateway associated with the VPN connection. </para> </li> <li> <para> <code>state</code> - The state of the VPN connection (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>). </para> </li> <li> <para> <code>option.static-routes-only</code> - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). </para> </li> <li> <para> <code>route.destination-cidr-block</code> - The destination CIDR block. This corresponds to the subnet used in a customer data center. </para> </li> <li> <para> <code>bgp-asn</code> - The BGP Autonomous System Number (ASN) associated with a BGP device. </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>type</code> - The type of VPN connection. Currently the only supported type is <code>ipsec.1</code>. </para> </li> <li> <para> <code>vpn-connection-id</code> - The ID of the VPN connection. </para> </li> <li> <para> <code>vpn-gateway-id</code> - The ID of a virtual private gateway associated with the VPN connection. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsRequest.VpnConnectionIds"> <summary> Gets and sets the property VpnConnectionIds. <para> One or more VPN connection IDs. </para> <para> Default: Describes your VPN connections. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsResponse"> <summary> Configuration for accessing Amazon DescribeVpnConnections service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnConnectionsResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsResult.VpnConnections"> <summary> Gets and sets the property VpnConnections. <para> Information about one or more VPN connections. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnConnectionsResponse.DescribeVpnConnectionsResult"> <summary> Gets and sets the DescribeVpnConnectionsResult property. Represents the output of a DescribeVpnConnections operation. </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysRequest"> <summary> Container for the parameters to the DescribeVpnGateways operation. Describes one or more of your virtual private gateways. <para> For more information about virtual private gateways, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html">Adding an IPsec Hardware VPN to Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysRequest.Filters"> <summary> Gets and sets the property Filters. <para> One or more filters. </para> <ul> <li> <para> <code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>). </para> </li> <li> <para> <code>attachment.vpc-id</code> - The ID of an attached VPC. </para> </li> <li> <para> <code>availability-zone</code> - The Availability Zone for the virtual private gateway. </para> </li> <li> <para> <code>state</code> - The state of the virtual private gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>). </para> </li> <li> <para> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. </para> </li> <li> <para> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> 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 <code>tag</code>:<i>key</i>=<i>value</i> filter. </para> </li> <li> <para> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter. </para> </li> <li> <para> <code>type</code> - The type of virtual private gateway. Currently the only supported type is <code>ipsec.1</code>. </para> </li> <li> <para> <code>vpn-gateway-id</code> - The ID of the virtual private gateway. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysRequest.VpnGatewayIds"> <summary> Gets and sets the property VpnGatewayIds. <para> One or more virtual private gateway IDs. </para> <para> Default: Describes all your virtual private gateways. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysResponse"> <summary> Configuration for accessing Amazon DescribeVpnGateways service </summary> </member> <member name="T:Amazon.EC2.Model.DescribeVpnGatewaysResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysResult.VpnGateways"> <summary> Gets and sets the property VpnGateways. <para> Information about one or more virtual private gateways. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DescribeVpnGatewaysResponse.DescribeVpnGatewaysResult"> <summary> Gets and sets the DescribeVpnGatewaysResult property. Represents the output of a DescribeVpnGateways operation. </summary> </member> <member name="T:Amazon.EC2.Model.DetachClassicLinkVpcRequest"> <summary> Container for the parameters to the DetachClassicLinkVpc operation. Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. </summary> </member> <member name="P:Amazon.EC2.Model.DetachClassicLinkVpcRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance to unlink from the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachClassicLinkVpcRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC to which the instance is linked. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DetachClassicLinkVpcResponse"> <summary> Configuration for accessing Amazon DetachClassicLinkVpc service </summary> </member> <member name="T:Amazon.EC2.Model.DetachClassicLinkVpcResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DetachClassicLinkVpcResult.Return"> <summary> Gets and sets the property Return. <para> Returns <code>true</code> if the request succeeds; otherwise, it returns an error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachClassicLinkVpcResponse.DetachClassicLinkVpcResult"> <summary> Gets and sets the DetachClassicLinkVpcResult property. Represents the output of a DetachClassicLinkVpc operation. </summary> </member> <member name="T:Amazon.EC2.Model.DetachInternetGatewayRequest"> <summary> Container for the parameters to the DetachInternetGateway operation. Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses. </summary> </member> <member name="P:Amazon.EC2.Model.DetachInternetGatewayRequest.InternetGatewayId"> <summary> Gets and sets the property InternetGatewayId. <para> The ID of the Internet gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachInternetGatewayRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DetachNetworkInterfaceRequest"> <summary> Container for the parameters to the DetachNetworkInterface operation. Detaches a network interface from an instance. </summary> </member> <member name="P:Amazon.EC2.Model.DetachNetworkInterfaceRequest.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachNetworkInterfaceRequest.Force"> <summary> Gets and sets the property Force. <para> Specifies whether to force a detachment. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DetachVolumeRequest"> <summary> Container for the parameters to the DetachVolume operation. Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching. <para> If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. </para> <para> When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html">Detaching an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DetachVolumeRequest.#ctor(System.String)"> <summary> Instantiates DetachVolumeRequest with the parameterized properties </summary> <param name="volumeId">The ID of the volume.</param> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.Device"> <summary> Gets and sets the property Device. <para> The device name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.Force"> <summary> Gets and sets the property Force. <para> Forces detachment if the previous detachment attempt did not occur cleanly (for example, 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 won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DetachVolumeResponse"> <summary> Configuration for accessing Amazon DetachVolume service </summary> </member> <member name="T:Amazon.EC2.Model.DetachVolumeResult"> <summary> Contains the response data from the DetachVolume operation. </summary> </member> <member name="P:Amazon.EC2.Model.DetachVolumeResponse.DetachVolumeResult"> <summary> Gets and sets the DetachVolumeResult property. Represents the output of a DetachVolume operation. </summary> </member> <member name="T:Amazon.EC2.Model.DetachVpnGatewayRequest"> <summary> Container for the parameters to the DetachVpnGateway operation. Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). <para> You must wait for the attachment's state to switch to <code>detached</code> before you can delete the VPC or attach a different VPC to the virtual private gateway. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DetachVpnGatewayRequest.#ctor(System.String,System.String)"> <summary> Instantiates DetachVpnGatewayRequest with the parameterized properties </summary> <param name="vpnGatewayId">The ID of the virtual private gateway.</param> <param name="vpcId">The ID of the VPC.</param> </member> <member name="P:Amazon.EC2.Model.DetachVpnGatewayRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DetachVpnGatewayRequest.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DhcpConfiguration"> <summary> Describes a DHCP configuration option. </summary> </member> <member name="P:Amazon.EC2.Model.DhcpConfiguration.Key"> <summary> Gets and sets the property Key. <para> The name of a DHCP option. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DhcpConfiguration.Values"> <summary> Gets and sets the property Values. <para> One or more values for the DHCP option. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DhcpOptions"> <summary> Describes a set of DHCP options. </summary> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.DhcpConfigurations"> <summary> Gets and sets the property DhcpConfigurations. <para> One or more DHCP options in the set. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.DhcpOptionsId"> <summary> Gets and sets the property DhcpOptionsId. <para> The ID of the set of DHCP options. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DhcpOptions.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the DHCP options set. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DisableVgwRoutePropagationRequest"> <summary> Container for the parameters to the DisableVgwRoutePropagation operation. Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.DisableVgwRoutePropagationRequest.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DisableVgwRoutePropagationRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DisableVpcClassicLinkRequest"> <summary> Container for the parameters to the DisableVpcClassicLink operation. Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. </summary> </member> <member name="P:Amazon.EC2.Model.DisableVpcClassicLinkRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DisableVpcClassicLinkResponse"> <summary> Configuration for accessing Amazon DisableVpcClassicLink service </summary> </member> <member name="T:Amazon.EC2.Model.DisableVpcClassicLinkResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.DisableVpcClassicLinkResult.Return"> <summary> Gets and sets the property Return. <para> Returns <code>true</code> if the request succeeds; otherwise, it returns an error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DisableVpcClassicLinkResponse.DisableVpcClassicLinkResult"> <summary> Gets and sets the DisableVpcClassicLinkResult property. Represents the output of a DisableVpcClassicLink operation. </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateAddressRequest"> <summary> Container for the parameters to the DisassociateAddress operation. Disassociates an Elastic IP address from the instance or network interface it's associated with. <para> An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. </para> </summary> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.DisassociateAddressRequest.#ctor(System.String)"> <summary> Instantiates DisassociateAddressRequest with the parameterized properties </summary> <param name="publicIp">[EC2-Classic] The Elastic IP address. Required for EC2-Classic.</param> </member> <member name="P:Amazon.EC2.Model.DisassociateAddressRequest.AssociationId"> <summary> Gets and sets the property AssociationId. <para> [EC2-VPC] The association ID. Required for EC2-VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DisassociateAddressRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> [EC2-Classic] The Elastic IP address. Required for EC2-Classic. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DisassociateRouteTableRequest"> <summary> Container for the parameters to the DisassociateRouteTable operation. Disassociates a subnet from a route table. <para> After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DisassociateRouteTableRequest.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The association ID representing the current association between the route table and subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DiskImage"> <summary> Describes a disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImage.Description"> <summary> Gets and sets the property Description. <para> A description of the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImage.Image"> <summary> Gets and sets the property Image. <para> Information about the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImage.Volume"> <summary> Gets and sets the property Volume. <para> Information about the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageDescription"> <summary> Describes a disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescription.Checksum"> <summary> Gets and sets the property Checksum. <para> The checksum computed for the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescription.Format"> <summary> Gets and sets the property Format. <para> The disk image format. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescription.ImportManifestUrl"> <summary> Gets and sets the property ImportManifestUrl. <para> A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">Authenticating REST Requests</a> topic in the <i>Amazon Simple Storage Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDescription.Size"> <summary> Gets and sets the property Size. <para> The size of the disk image, in GiB. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageDetail"> <summary> Describes a disk image. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDetail.Bytes"> <summary> Gets and sets the property Bytes. <para> The size of the disk image, in GiB. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDetail.Format"> <summary> Gets and sets the property Format. <para> The disk image format. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageDetail.ImportManifestUrl"> <summary> Gets and sets the property ImportManifestUrl. <para> A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the <a href="http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html">Authenticating REST Requests</a> topic in the <i>Amazon Simple Storage Service Developer Guide</i>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DiskImageVolumeDescription"> <summary> Describes a disk image volume. </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageVolumeDescription.Id"> <summary> Gets and sets the property Id. <para> The volume identifier. </para> </summary> </member> <member name="P:Amazon.EC2.Model.DiskImageVolumeDescription.Size"> <summary> Gets and sets the property Size. <para> The size of the volume, in GiB. </para> </summary> </member> <member name="T:Amazon.EC2.Model.DryRunResponse"> <summary> Returns information about the DryRun response and response metadata. </summary> </member> <member name="T:Amazon.EC2.Model.DryRunResult"> <summary> <para> The result of the DryRun operation. </para> </summary> </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="P:Amazon.EC2.Model.DryRunResponse.DryRunResult"> <summary> Gets and sets the DryRunResult property. The result of the DryRun operation. </summary> </member> <member name="T:Amazon.EC2.Model.EbsBlockDevice"> <summary> Describes a block device for an EBS volume. </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the EBS volume is deleted on instance termination. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.Iops"> <summary> Gets and sets the property Iops. <para> The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes. </para> <para> Condition: This parameter is required for requests to create <code>io1</code> volumes; it is not used in requests to create <code>standard</code> or <code>gp2</code> volumes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.VolumeSize"> <summary> Gets and sets the property VolumeSize. <para> The size of the volume, in GiB. </para> <para> Constraints: <code>1-1024</code> for <code>standard</code> volumes, <code>1-16384</code> for <code>gp2</code> volumes, and <code>4-16384</code> for <code>io1</code> volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. </para> <para> Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsBlockDevice.VolumeType"> <summary> Gets and sets the property VolumeType. <para> The volume type. <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, and <code>standard</code> for Magnetic volumes. </para> <para> Default: <code>standard</code> </para> </summary> </member> <member name="T:Amazon.EC2.Model.EbsInstanceBlockDevice"> <summary> Describes a parameter used to set up an EBS volume in a block device mapping. </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDevice.AttachTime"> <summary> Gets and sets the property AttachTime. <para> The time stamp when the attachment initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDevice.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the volume is deleted on instance termination. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDevice.Status"> <summary> Gets and sets the property Status. <para> The attachment state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDevice.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the EBS volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.EbsInstanceBlockDeviceSpecification"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDeviceSpecification.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the volume is deleted on instance termination. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EbsInstanceBlockDeviceSpecification.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the EBS volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.EnableVgwRoutePropagationRequest"> <summary> Container for the parameters to the EnableVgwRoutePropagation operation. Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.EnableVgwRoutePropagationRequest.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EnableVgwRoutePropagationRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="T:Amazon.EC2.Model.EnableVolumeIORequest"> <summary> Container for the parameters to the EnableVolumeIO operation. 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="P:Amazon.EC2.Model.EnableVolumeIORequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.EnableVpcClassicLinkRequest"> <summary> Container for the parameters to the EnableVpcClassicLink operation. Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the <code>10.0.0.0/8</code> IP address range, excluding local routes for VPCs in the <code>10.0.0.0/16</code> and <code>10.1.0.0/16</code> IP address ranges. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html">ClassicLink</a> in the Amazon Elastic Compute Cloud User Guide. </summary> </member> <member name="P:Amazon.EC2.Model.EnableVpcClassicLinkRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.EnableVpcClassicLinkResponse"> <summary> Configuration for accessing Amazon EnableVpcClassicLink service </summary> </member> <member name="T:Amazon.EC2.Model.EnableVpcClassicLinkResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.EnableVpcClassicLinkResult.Return"> <summary> Gets and sets the property Return. <para> Returns <code>true</code> if the request succeeds; otherwise, it returns an error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EnableVpcClassicLinkResponse.EnableVpcClassicLinkResult"> <summary> Gets and sets the EnableVpcClassicLinkResult property. Represents the output of a EnableVpcClassicLink operation. </summary> </member> <member name="T:Amazon.EC2.Model.EventInformation"> <summary> Describes a Spot fleet event. </summary> </member> <member name="P:Amazon.EC2.Model.EventInformation.EventDescription"> <summary> Gets and sets the property EventDescription. <para> The description of the event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.EventInformation.EventSubType"> <summary> Gets and sets the property EventSubType. <para> The event. </para> <para> The following are the <code>error</code> events. </para> <ul> <li> <para> <code>iamFleetRoleInvalid</code> - Spot fleet did not have the required permissions either to launch or terminate an instance. </para> </li> <li> <para> <code>spotFleetRequestConfigurationInvalid</code> - The configuration is not valid. For more information, see the description. </para> </li> <li> <para> <code>spotInstanceCountLimitExceeded</code> - You've reached the limit on the number of Spot instances that you can launch. </para> </li> </ul> <para> The following are the <code>fleetRequestChange</code> events. </para> <ul> <li> <para> <code>active</code> - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances. </para> </li> <li> <para> <code>cancelled</code> - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated. </para> </li> <li> <para> <code>cancelled_running</code> - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated. </para> </li> <li> <para> <code>cancelled_terminating</code> - The Spot fleet is canceled and its Spot instances are terminating. </para> </li> <li> <para> <code>expired</code> - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with <code>TerminateInstancesWithExpiration</code> set. </para> </li> <li> <para> <code>price_update</code> - The bid price for a launch configuration was adjusted because it was too high. This change is permanent. </para> </li> <li> <para> <code>submitted</code> - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances. </para> </li> </ul> <para> The following are the <code>instanceChange</code> events. </para> <ul> <li> <para> <code>launched</code> - A bid was fulfilled and a new instance was launched. </para> </li> <li> <para> <code>terminated</code> - An instance was terminated by the user. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.EventInformation.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. This information is available only for <code>instanceChange</code> events. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ExportTask"> <summary> Describes an instance export task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.Description"> <summary> Gets and sets the property Description. <para> A description of the resource being exported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.ExportTaskId"> <summary> Gets and sets the property ExportTaskId. <para> The ID of the export task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.ExportToS3Task"> <summary> Gets and sets the property ExportToS3Task. <para> Information about the export task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.InstanceExportDetails"> <summary> Gets and sets the property InstanceExportDetails. <para> Information about the instance to export. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.State"> <summary> Gets and sets the property State. <para> The state of the export task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportTask.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> The status message related to the export task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ExportToS3Task"> <summary> Describes the format and location for an instance export task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3Task.ContainerFormat"> <summary> Gets and sets the property ContainerFormat. <para> The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3Task.DiskImageFormat"> <summary> Gets and sets the property DiskImageFormat. <para> The format for the exported image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3Task.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account <code>vm-import-export@amazon.com</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3Task.S3Key"> <summary> Gets and sets the property S3Key. <para> The encryption key for your S3 bucket. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ExportToS3TaskSpecification"> <summary> Describes an instance export task. </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskSpecification.ContainerFormat"> <summary> Gets and sets the property ContainerFormat. <para> The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskSpecification.DiskImageFormat"> <summary> Gets and sets the property DiskImageFormat. <para> The format for the exported image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskSpecification.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account <code>vm-import-export@amazon.com</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ExportToS3TaskSpecification.S3Prefix"> <summary> Gets and sets the property S3Prefix. <para> The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Filter"> <summary> A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs. </summary> </member> <member name="M:Amazon.EC2.Model.Filter.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.Filter.#ctor(System.String,System.Collections.Generic.List{System.String})"> <summary> Instantiates Filter with the parameterized properties </summary> <param name="name">The name of the filter. Filter names are case-sensitive.</param> <param name="values">One or more filter values. Filter values are case-sensitive.</param> </member> <member name="M:Amazon.EC2.Model.Filter.#ctor(System.String)"> <summary> Instantiates Filter with the parameterized properties </summary> <param name="name">The name of the filter. Filter names are case-sensitive.</param> </member> <member name="P:Amazon.EC2.Model.Filter.Name"> <summary> Gets and sets the property Name. <para> The name of the filter. Filter names are case-sensitive. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Filter.Values"> <summary> Gets and sets the property Values. <para> One or more filter values. Filter values are case-sensitive. </para> </summary> </member> <member name="T:Amazon.EC2.Model.FlowLog"> <summary> Describes a flow log. </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.CreationTime"> <summary> Gets and sets the property CreationTime. <para> The date and time the flow log was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.DeliverLogsErrorMessage"> <summary> Gets and sets the property DeliverLogsErrorMessage. <para> Information about the error that occurred. <code>Rate limited</code> indicates that CloudWatch logs throttling has been applied for one or more network interfaces. <code>Access error</code> indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. <code>Unknown error</code> indicates an internal error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.DeliverLogsPermissionArn"> <summary> Gets and sets the property DeliverLogsPermissionArn. <para> The ARN of the IAM role that posts logs to CloudWatch Logs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.DeliverLogsStatus"> <summary> Gets and sets the property DeliverLogsStatus. <para> The status of the logs delivery (<code>SUCCESS</code> | <code>FAILED</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.FlowLogId"> <summary> Gets and sets the property FlowLogId. <para> The flow log ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.FlowLogStatus"> <summary> Gets and sets the property FlowLogStatus. <para> The status of the flow log (<code>ACTIVE</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.LogGroupName"> <summary> Gets and sets the property LogGroupName. <para> The name of the flow log group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource on which the flow log was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.FlowLog.TrafficType"> <summary> Gets and sets the property TrafficType. <para> The type of traffic captured for the flow log. </para> </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputRequest"> <summary> Container for the parameters to the GetConsoleOutput operation. Gets the console output for the specified instance. <para> Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface. </para> <para> Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post. </para> <para> For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it. </para> <para> For Windows instances, the instance console output includes output from the EC2Config service. </para> </summary> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.GetConsoleOutputRequest.#ctor(System.String)"> <summary> Instantiates GetConsoleOutputRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance.</param> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputResponse"> <summary> Configuration for accessing Amazon GetConsoleOutput service </summary> </member> <member name="T:Amazon.EC2.Model.GetConsoleOutputResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResult.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResult.Output"> <summary> Gets and sets the property Output. <para> The console output, Base64 encoded. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResult.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time the output was last updated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetConsoleOutputResponse.GetConsoleOutputResult"> <summary> Gets and sets the GetConsoleOutputResult property. Represents the output of a GetConsoleOutput operation. </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataRequest"> <summary> Container for the parameters to the GetPasswordData operation. Retrieves the encrypted administrator password for an instance running Windows. <para> The Windows password is generated at boot if the <code>EC2Config</code> service plugin, <code>Ec2SetPassword</code>, is enabled. This usually only happens the first time an AMI is launched, and then <code>Ec2SetPassword</code> is automatically disabled. The password is not generated for rebundled AMIs unless <code>Ec2SetPassword</code> is enabled before bundling. </para> <para> The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. </para> <para> Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. </para> </summary> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.GetPasswordDataRequest.#ctor(System.String)"> <summary> Instantiates GetPasswordDataRequest with the parameterized properties </summary> <param name="instanceId">The ID of the Windows instance.</param> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the Windows instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataResponse"> <summary> Configuration for accessing Amazon GetPasswordData service </summary> </member> <member name="T:Amazon.EC2.Model.GetPasswordDataResult"> <summary> </summary> </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.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the Windows instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResult.PasswordData"> <summary> Gets and sets the property PasswordData. <para> The password of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResult.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The time the data was last updated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GetPasswordDataResponse.GetPasswordDataResult"> <summary> Gets and sets the GetPasswordDataResult property. Represents the output of a GetPasswordData operation. </summary> </member> <member name="T:Amazon.EC2.Model.GroupIdentifier"> <summary> Describes a security group. </summary> </member> <member name="P:Amazon.EC2.Model.GroupIdentifier.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.GroupIdentifier.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the security group. </para> </summary> </member> <member name="T:Amazon.EC2.Model.HistoryRecord"> <summary> Describes an event in the history of the Spot fleet request. </summary> </member> <member name="P:Amazon.EC2.Model.HistoryRecord.EventInformation"> <summary> Gets and sets the property EventInformation. <para> Information about the event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.HistoryRecord.EventType"> <summary> Gets and sets the property EventType. <para> The event type. </para> <ul> <li> <para> <code>error</code> - Indicates an error with the Spot fleet request. </para> </li> <li> <para> <code>fleetRequestChange</code> - Indicates a change in the status or configuration of the Spot fleet request. </para> </li> <li> <para> <code>instanceChange</code> - Indicates that an instance was launched or terminated. </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.HistoryRecord.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The date and time of the event, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="T:Amazon.EC2.Model.IamInstanceProfile"> <summary> Describes an IAM instance profile. </summary> </member> <member name="P:Amazon.EC2.Model.IamInstanceProfile.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the instance profile. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IamInstanceProfile.Id"> <summary> Gets and sets the property Id. <para> The ID of the instance profile. </para> </summary> </member> <member name="T:Amazon.EC2.Model.IamInstanceProfileSpecification"> <summary> Describes an IAM instance profile. </summary> </member> <member name="P:Amazon.EC2.Model.IamInstanceProfileSpecification.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the instance profile. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IamInstanceProfileSpecification.Name"> <summary> Gets and sets the property Name. <para> The name of the instance profile. </para> </summary> </member> <member name="T:Amazon.EC2.Model.IcmpTypeCode"> <summary> Describes the ICMP type and code. </summary> </member> <member name="P:Amazon.EC2.Model.IcmpTypeCode.Code"> <summary> Gets and sets the property Code. <para> The ICMP type. A value of -1 means all types. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IcmpTypeCode.Type"> <summary> Gets and sets the property Type. <para> The ICMP code. A value of -1 means all codes for the specified ICMP type. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Image"> <summary> Describes an image. </summary> </member> <member name="P:Amazon.EC2.Model.Image.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> Any block device mapping entries. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.CreationDate"> <summary> Gets and sets the property CreationDate. <para> The date and time the image was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Description"> <summary> Gets and sets the property Description. <para> The description of the AMI that was provided during image creation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Hypervisor"> <summary> Gets and sets the property Hypervisor. <para> The hypervisor type of the image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageLocation"> <summary> Gets and sets the property ImageLocation. <para> The location of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageOwnerAlias"> <summary> Gets and sets the property ImageOwnerAlias. <para> The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or the AWS account ID of the AMI owner. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.ImageType"> <summary> Gets and sets the property ImageType. <para> The type of image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.KernelId"> <summary> Gets and sets the property KernelId. <para> The kernel associated with the image, if any. Only applicable for machine images. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Name"> <summary> Gets and sets the property Name. <para> The name of the AMI that was provided during image creation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the image owner. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Platform"> <summary> Gets and sets the property Platform. <para> The value is <code>Windows</code> for Windows AMIs; otherwise blank. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> Any product codes associated with the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Public"> <summary> Gets and sets the property Public. <para> Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The RAM disk associated with the image, if any. Only applicable for machine images. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.RootDeviceName"> <summary> Gets and sets the property RootDeviceName. <para> The device name of the root device (for example, <code>/dev/sda1</code> or <code>/dev/xvda</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.RootDeviceType"> <summary> Gets and sets the property RootDeviceType. <para> The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. <para> Specifies whether enhanced networking is enabled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.State"> <summary> Gets and sets the property State. <para> The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.StateReason"> <summary> Gets and sets the property StateReason. <para> The reason for the state change. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Image.VirtualizationType"> <summary> Gets and sets the property VirtualizationType. <para> The type of virtualization of the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImageAttribute"> <summary> Describes an image attribute. </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> One or more block device mapping entries. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.Description"> <summary> Gets and sets the property Description. <para> A description for the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.KernelId"> <summary> Gets and sets the property KernelId. <para> The kernel ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.LaunchPermissions"> <summary> Gets and sets the property LaunchPermissions. <para> One or more launch permissions. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> One or more product codes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The RAM disk ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageAttribute.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. </summary> </member> <member name="T:Amazon.EC2.Model.ImageDiskContainer"> <summary> Describes the disk container object for an import image task. </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.Description"> <summary> Gets and sets the property Description. <para> The description of the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The block device mapping for the disk. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.Format"> <summary> Gets and sets the property Format. <para> The format of the disk image being imported. </para> <para> Valid values: <code>RAW</code> | <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the EBS snapshot to be used for importing the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.Url"> <summary> Gets and sets the property Url. <para> The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..) </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImageDiskContainer.UserBucket"> <summary> Gets and sets the property UserBucket. <para> The S3 bucket for the disk image. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportImageRequest"> <summary> Container for the parameters to the ImportImage operation. Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the virtual machine. </para> <para> Valid values: <code>i386</code> | <code>x86_64</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.ClientData"> <summary> Gets and sets the property ClientData. <para> The client-specific data. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The token to enable idempotency for VM import requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.Description"> <summary> Gets and sets the property Description. <para> A description string for the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.DiskContainers"> <summary> Gets and sets the property DiskContainers. <para> Information about the disk containers. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.Hypervisor"> <summary> Gets and sets the property Hypervisor. <para> The target hypervisor platform. </para> <para> Valid values: <code>xen</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.LicenseType"> <summary> Gets and sets the property LicenseType. <para> The license type to be used for the Amazon Machine Image (AMI) after importing. </para> <para> <b>Note:</b> You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html">VM Import/Export Prerequisites</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> Valid values: <code>AWS</code> | <code>BYOL</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.Platform"> <summary> Gets and sets the property Platform. <para> The operating system of the virtual machine. </para> <para> Valid values: <code>Windows</code> | <code>Linux</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageRequest.RoleName"> <summary> Gets and sets the property RoleName. <para> The name of the role to use when not using the default role, 'vmimport'. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportImageResponse"> <summary> Configuration for accessing Amazon ImportImage service </summary> </member> <member name="T:Amazon.EC2.Model.ImportImageResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the virtual machine. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Description"> <summary> Gets and sets the property Description. <para> A description of the import task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Hypervisor"> <summary> Gets and sets the property Hypervisor. <para> The target hypervisor of the import task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the Amazon Machine Image (AMI) created by the import task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The task ID of the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.LicenseType"> <summary> Gets and sets the property LicenseType. <para> The license type of the virtual machine. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Platform"> <summary> Gets and sets the property Platform. <para> The operating system of the virtual machine. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Progress"> <summary> Gets and sets the property Progress. <para> The progress of the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.SnapshotDetails"> <summary> Gets and sets the property SnapshotDetails. <para> Information about the snapshots. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.Status"> <summary> Gets and sets the property Status. <para> A brief status of the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResult.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> A detailed status message of the import task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageResponse.ImportImageResult"> <summary> Gets and sets the ImportImageResult property. Represents the output of a ImportImage operation. </summary> </member> <member name="T:Amazon.EC2.Model.ImportImageTask"> <summary> Describes an import image task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the virtual machine. </para> <para> Valid values: <code>i386</code> | <code>x86_64</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Description"> <summary> Gets and sets the property Description. <para> A description of the import task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Hypervisor"> <summary> Gets and sets the property Hypervisor. <para> The target hypervisor for the import task. </para> <para> Valid values: <code>xen</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the Amazon Machine Image (AMI) of the imported virtual machine. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The ID of the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.LicenseType"> <summary> Gets and sets the property LicenseType. <para> The license type of the virtual machine. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Platform"> <summary> Gets and sets the property Platform. <para> The description string for the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Progress"> <summary> Gets and sets the property Progress. <para> The percentage of progress of the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.SnapshotDetails"> <summary> Gets and sets the property SnapshotDetails. <para> Information about the snapshots. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.Status"> <summary> Gets and sets the property Status. <para> A brief status for the import image task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportImageTask.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> A descriptive status message for the import image task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceLaunchSpecification"> <summary> Describes the launch specification for VM import. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.AdditionalInfo"> <summary> Gets and sets the property AdditionalInfo. <para> Reserved. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.GroupIds"> <summary> Gets and sets the property GroupIds. <para> One or more security group IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.GroupNames"> <summary> Gets and sets the property GroupNames. <para> One or more security group names. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.InstanceInitiatedShutdownBehavior"> <summary> Gets and sets the property InstanceInitiatedShutdownBehavior. <para> Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. For more information about the instance types that you can import, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html">Before You Get Started</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.Monitoring"> <summary> Gets and sets the property Monitoring. <para> Indicates whether monitoring is enabled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.Placement"> <summary> Gets and sets the property Placement. <para> The placement information for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> [EC2-VPC] An available IP address from the IP address range of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.SubnetId"> <summary> Gets and sets the property SubnetId. <para> [EC2-VPC] The ID of the subnet in which to launch the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceLaunchSpecification.UserData"> <summary> Gets and sets the property UserData. <para> The Base64-encoded MIME user data to be made available to the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceRequest"> <summary> Container for the parameters to the ImportInstance operation. Creates an import instance task using metadata from the specified disk image. <code>ImportInstance</code> only supports single-volume VMs. To import multi-volume VMs, use <a>ImportImage</a>. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the EC2 command line tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the instance being imported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.DiskImages"> <summary> Gets and sets the property DiskImages. <para> The disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.LaunchSpecification"> <summary> Gets and sets the property LaunchSpecification. <para> The launch specification. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceRequest.Platform"> <summary> Gets and sets the property Platform. <para> The instance operating system. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceResponse"> <summary> Configuration for accessing Amazon ImportInstance service </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceResult.ConversionTask"> <summary> Gets and sets the property ConversionTask. <para> Information about the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceResponse.ImportInstanceResult"> <summary> Gets and sets the ImportInstanceResult property. Represents the output of a ImportInstance operation. </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceTaskDetails"> <summary> Describes an import instance task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetails.Description"> <summary> Gets and sets the property Description. <para> A description of the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetails.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetails.Platform"> <summary> Gets and sets the property Platform. <para> The instance operating system. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceTaskDetails.Volumes"> <summary> Gets and sets the property Volumes. <para> One or more volumes. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportInstanceVolumeDetailItem"> <summary> Describes an import volume task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone where the resulting instance will reside. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.BytesConverted"> <summary> Gets and sets the property BytesConverted. <para> The number of bytes converted so far. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.Description"> <summary> Gets and sets the property Description. <para> A description of the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.Image"> <summary> Gets and sets the property Image. <para> The image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.Status"> <summary> Gets and sets the property Status. <para> The status of the import of this particular disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> The status information or errors related to the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportInstanceVolumeDetailItem.Volume"> <summary> Gets and sets the property Volume. <para> The volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairRequest"> <summary> Container for the parameters to the ImportKeyPair operation. Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS. <para> For more information about key pairs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ImportKeyPairRequest.#ctor(System.String,System.String)"> <summary> Instantiates ImportKeyPairRequest with the parameterized properties </summary> <param name="keyName">A unique name for the key pair.</param> <param name="publicKeyMaterial">The public key. You must base64 encode the public key material before sending it to AWS.</param> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> A unique name for the key pair. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairRequest.PublicKeyMaterial"> <summary> Gets and sets the property PublicKeyMaterial. <para> The public key. You must base64 encode the public key material before sending it to AWS. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairResponse"> <summary> Configuration for accessing Amazon ImportKeyPair service </summary> </member> <member name="T:Amazon.EC2.Model.ImportKeyPairResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResult.KeyFingerprint"> <summary> Gets and sets the property KeyFingerprint. <para> The MD5 public key fingerprint as specified in section 4 of RFC 4716. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResult.KeyName"> <summary> Gets and sets the property KeyName. <para> The key pair name you provided. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportKeyPairResponse.ImportKeyPairResult"> <summary> Gets and sets the ImportKeyPairResult property. Represents the output of a ImportKeyPair operation. </summary> </member> <member name="T:Amazon.EC2.Model.ImportSnapshotRequest"> <summary> Container for the parameters to the ImportSnapshot operation. Imports a disk into an EBS snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotRequest.ClientData"> <summary> Gets and sets the property ClientData. <para> The client-specific data. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Token to enable idempotency for VM import requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotRequest.Description"> <summary> Gets and sets the property Description. <para> The description string for the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotRequest.DiskContainer"> <summary> Gets and sets the property DiskContainer. <para> Information about the disk container. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotRequest.RoleName"> <summary> Gets and sets the property RoleName. <para> The name of the role to use when not using the default role, 'vmimport'. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportSnapshotResponse"> <summary> Configuration for accessing Amazon ImportSnapshot service </summary> </member> <member name="T:Amazon.EC2.Model.ImportSnapshotResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotResult.Description"> <summary> Gets and sets the property Description. <para> A description of the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotResult.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The ID of the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotResult.SnapshotTaskDetail"> <summary> Gets and sets the property SnapshotTaskDetail. <para> Information about the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotResponse.ImportSnapshotResult"> <summary> Gets and sets the ImportSnapshotResult property. Represents the output of a ImportSnapshot operation. </summary> </member> <member name="T:Amazon.EC2.Model.ImportSnapshotTask"> <summary> Describes an import snapshot task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotTask.Description"> <summary> Gets and sets the property Description. <para> A description of the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotTask.ImportTaskId"> <summary> Gets and sets the property ImportTaskId. <para> The ID of the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportSnapshotTask.SnapshotTaskDetail"> <summary> Gets and sets the property SnapshotTaskDetail. <para> Describes an import snapshot task. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeRequest"> <summary> Container for the parameters to the ImportVolume operation. Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the <code>ec2-import-volume</code> command in the Amazon EC2 command-line interface (CLI) tools. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html">Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the resulting EBS volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Description"> <summary> Gets and sets the property Description. <para> A description of the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Image"> <summary> Gets and sets the property Image. <para> The disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeRequest.Volume"> <summary> Gets and sets the property Volume. <para> The volume size. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeResponse"> <summary> Configuration for accessing Amazon ImportVolume service </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeResult.ConversionTask"> <summary> Gets and sets the property ConversionTask. <para> Information about the conversion task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeResponse.ImportVolumeResult"> <summary> Gets and sets the ImportVolumeResult property. Represents the output of a ImportVolume operation. </summary> </member> <member name="T:Amazon.EC2.Model.ImportVolumeTaskDetails"> <summary> Describes an import volume task. </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetails.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone where the resulting volume will reside. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetails.BytesConverted"> <summary> Gets and sets the property BytesConverted. <para> The number of bytes converted so far. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetails.Description"> <summary> Gets and sets the property Description. <para> The description you provided when starting the import volume task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetails.Image"> <summary> Gets and sets the property Image. <para> The image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ImportVolumeTaskDetails.Volume"> <summary> Gets and sets the property Volume. <para> The volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Instance"> <summary> Describes an instance. </summary> </member> <member name="P:Amazon.EC2.Model.Instance.AmiLaunchIndex"> <summary> Gets and sets the property AmiLaunchIndex. <para> The AMI launch index, which can be used to find this instance in the launch group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> Any block device mapping entries for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.ClientToken"> <summary> Gets and sets the property ClientToken. <para> The idempotency token you provided when you launched the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Hypervisor"> <summary> Gets and sets the property Hypervisor. <para> The hypervisor type of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The IAM instance profile associated with the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI used to launch the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.InstanceLifecycle"> <summary> Gets and sets the property InstanceLifecycle. <para> Indicates whether this is a Spot Instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.KernelId"> <summary> Gets and sets the property KernelId. <para> The kernel associated with this instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair, if this instance was launched with an associated key pair. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.LaunchTime"> <summary> Gets and sets the property LaunchTime. <para> The time the instance was launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Monitoring"> <summary> Gets and sets the property Monitoring. <para> The monitoring information for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.NetworkInterfaces"> <summary> Gets and sets the property NetworkInterfaces. <para> [EC2-VPC] One or more network interfaces for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Placement"> <summary> Gets and sets the property Placement. <para> The location where the instance launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Platform"> <summary> Gets and sets the property Platform. <para> The value is <code>Windows</code> for Windows instances; otherwise blank. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the <code>running</code> state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address assigned to the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> The product codes attached to this instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.PublicDnsName"> <summary> Gets and sets the property PublicDnsName. <para> The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.PublicIpAddress"> <summary> Gets and sets the property PublicIpAddress. <para> The public IP address assigned to the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The RAM disk associated with this instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.RootDeviceName"> <summary> Gets and sets the property RootDeviceName. <para> The root device name (for example, <code>/dev/sda1</code> or <code>/dev/xvda</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.RootDeviceType"> <summary> Gets and sets the property RootDeviceType. <para> The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> One or more security groups for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.SpotInstanceRequestId"> <summary> Gets and sets the property SpotInstanceRequestId. <para> The ID of the Spot Instance request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. <para> Specifies whether enhanced networking is enabled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.State"> <summary> Gets and sets the property State. <para> The current state of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.StateReason"> <summary> Gets and sets the property StateReason. <para> The reason for the most recent state transition. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.StateTransitionReason"> <summary> Gets and sets the property StateTransitionReason. <para> The reason for the most recent state transition. This might be an empty string. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet in which the instance is running. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.VirtualizationType"> <summary> Gets and sets the property VirtualizationType. <para> The virtualization type of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Instance.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC in which the instance is running. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceAttribute"> <summary> Describes an instance attribute. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> The block device mapping of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.DisableApiTermination"> <summary> Gets and sets the property DisableApiTermination. <para> If the value is <code>true</code>, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instance is optimized for EBS I/O. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.Groups"> <summary> Gets and sets the property Groups. <para> The security groups associated with the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceInitiatedShutdownBehavior"> <summary> Gets and sets the property InstanceInitiatedShutdownBehavior. <para> Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.KernelId"> <summary> Gets and sets the property KernelId. <para> The kernel ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> A list of product codes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The RAM disk ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.RootDeviceName"> <summary> Gets and sets the property RootDeviceName. <para> The name of the root device (for example, <code>/dev/sda1</code> or <code>/dev/xvda</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Indicates whether source/destination checking is enabled. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. This value must be <code>false</code> for a NAT instance to perform NAT. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceAttribute.UserData"> <summary> Gets and sets the property UserData. <para> The Base64-encoded MIME user data. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceBlockDeviceMapping"> <summary> Describes a block device mapping. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMapping.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The device name exposed to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMapping.Ebs"> <summary> Gets and sets the property Ebs. <para> Parameters used to automatically set up EBS volumes when the instance is launched. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification"> <summary> Describes a block device mapping entry. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The device name exposed to the instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification.Ebs"> <summary> Gets and sets the property Ebs. <para> Parameters used to automatically set up EBS volumes when the instance is launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification.NoDevice"> <summary> Gets and sets the property NoDevice. <para> suppress the specified device included in the block device mapping. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceBlockDeviceMappingSpecification.VirtualName"> <summary> Gets and sets the property VirtualName. <para> The virtual device name. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceCount"> <summary> Describes a Reserved Instance listing state. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceCount.Count"> <summary> Gets and sets the property Count. <para> The number of listed Reserved Instances in the state specified by the <code>state</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceCount.State"> <summary> Gets and sets the property State. <para> The states of the listed Reserved Instances. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceExportDetails"> <summary> Describes an instance to export. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceExportDetails.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the resource being exported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceExportDetails.TargetEnvironment"> <summary> Gets and sets the property TargetEnvironment. <para> The target virtualization environment. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceLicenseSpecification"> <summary>Instance License Specification </summary> </member> <member name="T:Amazon.EC2.Model.InstanceMonitoring"> <summary> Describes the monitoring information of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceMonitoring.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceMonitoring.Monitoring"> <summary> Gets and sets the property Monitoring. <para> The monitoring information. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterface"> <summary> Describes a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Association"> <summary> Gets and sets the property Association. <para> The association information for an Elastic IP associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Attachment"> <summary> Gets and sets the property Attachment. <para> The network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Description"> <summary> Gets and sets the property Description. <para> The description. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Groups"> <summary> Gets and sets the property Groups. <para> One or more security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.MacAddress"> <summary> Gets and sets the property MacAddress. <para> The MAC address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The ID of the AWS account that created the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The IP address of the network interface within the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> The private IP addresses associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Indicates whether to validate network traffic to or from this network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.Status"> <summary> Gets and sets the property Status. <para> The status of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterface.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation"> <summary> Describes association information for an Elastic IP address. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.IpOwnerId"> <summary> Gets and sets the property IpOwnerId. <para> The ID of the owner of the Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.PublicDnsName"> <summary> Gets and sets the property PublicDnsName. <para> The public DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAssociation.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The public IP address or Elastic IP address bound to the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment"> <summary> Describes a network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.AttachTime"> <summary> Gets and sets the property AttachTime. <para> The time stamp when the attachment initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the network interface is deleted when the instance is terminated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.DeviceIndex"> <summary> Gets and sets the property DeviceIndex. <para> The index of the device on the instance for the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceAttachment.Status"> <summary> Gets and sets the property Status. <para> The attachment state. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification"> <summary> Describes a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.AssociatePublicIpAddress"> <summary> Gets and sets the property AssociatePublicIpAddress. <para> Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is <code>true</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> If set to <code>true</code>, the interface is deleted when the instance is terminated. You can specify <code>true</code> only if creating a new network interface when launching an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.Description"> <summary> Gets and sets the property Description. <para> The description of the network interface. Applies only if creating a network interface when launching an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.DeviceIndex"> <summary> Gets and sets the property DeviceIndex. <para> The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a <a>RunInstances</a> request, you must provide the device index. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.Groups"> <summary> Gets and sets the property Groups. <para> The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address of the network interface. Applies only if creating a network interface when launching an instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.SecondaryPrivateIpAddressCount"> <summary> Gets and sets the property SecondaryPrivateIpAddressCount. <para> The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceNetworkInterfaceSpecification.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstancePrivateIpAddress"> <summary> Describes a private IP address. </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.Association"> <summary> Gets and sets the property Association. <para> The association information for an Elastic IP address for the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.Primary"> <summary> Gets and sets the property Primary. <para> Indicates whether this IP address is the primary private IP address of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstancePrivateIpAddress.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address of the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceState"> <summary> Describes the current state of the instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceState.Code"> <summary> Gets and sets the property Code. <para> The low byte represents the state. The high byte is an opaque internal value and should be ignored. </para> <ul> <li> <para> <code>0</code> : <code>pending</code> </para> </li> <li> <para> <code>16</code> : <code>running</code> </para> </li> <li> <para> <code>32</code> : <code>shutting-down</code> </para> </li> <li> <para> <code>48</code> : <code>terminated</code> </para> </li> <li> <para> <code>64</code> : <code>stopping</code> </para> </li> <li> <para> <code>80</code> : <code>stopped</code> </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceState.Name"> <summary> Gets and sets the property Name. <para> The current state of the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStateChange"> <summary> Describes an instance state change. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.CurrentState"> <summary> Gets and sets the property CurrentState. <para> The current state of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStateChange.PreviousState"> <summary> Gets and sets the property PreviousState. <para> The previous state of the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatus"> <summary> Describes the status of an instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.Events"> <summary> Gets and sets the property Events. <para> Any scheduled events associated with the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.InstanceState"> <summary> Gets and sets the property InstanceState. <para> The intended state of the instance. <a>DescribeInstanceStatus</a> requires that an instance be in the <code>running</code> state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.Status"> <summary> Gets and sets the property Status. <para> Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatus.SystemStatus"> <summary> Gets and sets the property SystemStatus. <para> Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusDetails"> <summary> Describes the instance status. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetails.ImpairedSince"> <summary> Gets and sets the property ImpairedSince. <para> The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetails.Name"> <summary> Gets and sets the property Name. <para> The type of instance status. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusDetails.Status"> <summary> Gets and sets the property Status. <para> The status. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusEvent"> <summary> Describes a scheduled event for an instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.Code"> <summary> Gets and sets the property Code. <para> The event code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.Description"> <summary> Gets and sets the property Description. <para> A description of the event. </para> <para> After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed]. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.NotAfter"> <summary> Gets and sets the property NotAfter. <para> The latest scheduled end time for the event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusEvent.NotBefore"> <summary> Gets and sets the property NotBefore. <para> The earliest scheduled start time for the event. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InstanceStatusSummary"> <summary> Describes the status of an instance. </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusSummary.Details"> <summary> Gets and sets the property Details. <para> The system instance health or application instance health. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InstanceStatusSummary.Status"> <summary> Gets and sets the property Status. <para> The status. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InternetGateway"> <summary> Describes an Internet gateway. </summary> </member> <member name="P:Amazon.EC2.Model.InternetGateway.Attachments"> <summary> Gets and sets the property Attachments. <para> Any VPCs attached to the Internet gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InternetGateway.InternetGatewayId"> <summary> Gets and sets the property InternetGatewayId. <para> The ID of the Internet gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InternetGateway.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the Internet gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.InternetGatewayAttachment"> <summary> Describes the attachment of a VPC to an Internet gateway. </summary> </member> <member name="P:Amazon.EC2.Model.InternetGatewayAttachment.State"> <summary> Gets and sets the property State. <para> The current state of the attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.InternetGatewayAttachment.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.IpPermission"> <summary> Describes a security group rule. </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.FromPort"> <summary> Gets and sets the property FromPort. <para> The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of <code>-1</code> indicates all ICMP types. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.IpProtocol"> <summary> Gets and sets the property IpProtocol. <para> The protocol. </para> <para> When you call <a>DescribeSecurityGroups</a>, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, <code>tcp</code>, <code>udp</code>, or <code>icmp</code>). For a list of protocol numbers, see <a href="http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml">Protocol Numbers</a>. (VPC only) When you call <a>AuthorizeSecurityGroupIngress</a>, you can use <code>-1</code> to specify all. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.IpRanges"> <summary> Gets and sets the property IpRanges. <para> One or more IP ranges. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.PrefixListIds"> <summary> Gets and sets the property PrefixListIds. <para> (Valid for <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupEgress</a> and <a>DescribeSecurityGroups</a> only) One or more prefix list IDs for an AWS service. In an <a>AuthorizeSecurityGroupEgress</a> request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.ToPort"> <summary> Gets and sets the property ToPort. <para> The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code> indicates all ICMP codes for the specified ICMP type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.IpPermission.UserIdGroupPairs"> <summary> Gets and sets the property UserIdGroupPairs. <para> One or more security group and AWS account ID pairs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.KeyPair"> <summary> Describes a key pair. </summary> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyFingerprint"> <summary> Gets and sets the property KeyFingerprint. <para> The SHA-1 digest of the DER encoded private key. </para> </summary> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyMaterial"> <summary> Gets and sets the property KeyMaterial. <para> An unencrypted PEM encoded RSA private key. </para> </summary> </member> <member name="P:Amazon.EC2.Model.KeyPair.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="T:Amazon.EC2.Model.KeyPairInfo"> <summary> Describes a key pair. </summary> </member> <member name="P:Amazon.EC2.Model.KeyPairInfo.KeyFingerprint"> <summary> Gets and sets the property KeyFingerprint. <para> If you used <a>CreateKeyPair</a> to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used <a>ImportKeyPair</a> to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716. </para> </summary> </member> <member name="P:Amazon.EC2.Model.KeyPairInfo.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="T:Amazon.EC2.Model.LaunchPermission"> <summary> Describes a launch permission. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchPermission.Group"> <summary> Gets and sets the property Group. <para> The name of the group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchPermission.UserId"> <summary> Gets and sets the property UserId. <para> The AWS account ID. </para> </summary> </member> <member name="T:Amazon.EC2.Model.LaunchPermissionModifications"> <summary> Describes a launch permission modification. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchPermissionModifications.Add"> <summary> Gets and sets the property Add. <para> The AWS account ID to add to the list of launch permissions for the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchPermissionModifications.Remove"> <summary> Gets and sets the property Remove. <para> The AWS account ID to remove from the list of launch permissions for the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.LaunchSpecification"> <summary> Describes the launch specification for an instance. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.AddressingType"> <summary> Gets and sets the property AddressingType. <para> Deprecated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.AllSecurityGroups"> <summary> Gets and sets the property AllSecurityGroups. <para> One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> One or more block device mapping entries. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The IAM instance profile. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.MonitoringEnabled"> <summary> Gets and sets the property MonitoringEnabled. </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.NetworkInterfaces"> <summary> Gets and sets the property NetworkInterfaces. <para> One or more network interfaces. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.Placement"> <summary> Gets and sets the property Placement. <para> The placement information for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> One or more security group names. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet in which to launch the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.LaunchSpecification.UserData"> <summary> Gets and sets the property UserData. <para> The Base64-encoded MIME user data to make available to the instances. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyImageAttributeRequest"> <summary> Container for the parameters to the ModifyImageAttribute operation. Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. <note> <para> AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public. </para> </note> </summary> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ModifyImageAttributeRequest.#ctor(System.String,System.String)"> <summary> Instantiates ModifyImageAttributeRequest with the parameterized properties </summary> <param name="imageId">The ID of the AMI.</param> <param name="attribute">The name of the attribute to modify.</param> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The name of the attribute to modify. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.LaunchPermission"> <summary> Gets and sets the property LaunchPermission. <para> A launch permission modification. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.OperationType"> <summary> Gets and sets the property OperationType. <para> The operation type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.ProductCodes"> <summary> Gets and sets the property ProductCodes. <para> One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the <code>productCodes</code> attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.UserGroups"> <summary> Gets and sets the property UserGroups. <para> One or more user groups. This is only valid when modifying the <code>launchPermission</code> attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.UserIds"> <summary> Gets and sets the property UserIds. <para> One or more AWS account IDs. This is only valid when modifying the <code>launchPermission</code> attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyImageAttributeRequest.Value"> <summary> Gets and sets the property Value. <para> The value of the attribute being modified. This is only valid when modifying the <code>description</code> attribute. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyInstanceAttributeRequest"> <summary> Container for the parameters to the ModifyInstanceAttribute operation. Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. <para> To modify some attributes, the instance must be stopped. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modifying Attributes of a Stopped Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ModifyInstanceAttributeRequest.#ctor(System.String,Amazon.EC2.InstanceAttributeName)"> <summary> Instantiates ModifyInstanceAttributeRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance.</param> <param name="attribute">The name of the attribute.</param> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The name of the attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> Modifies the <code>DeleteOnTermination</code> attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for <code>DeleteOnTermination</code>, the default is <code>true</code> and the volume is deleted when the instance is terminated. </para> <para> To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM">Updating the Block Device Mapping when Launching an Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.DisableApiTermination"> <summary> Gets and sets the property DisableApiTermination. <para> If the value is <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Groups"> <summary> Gets and sets the property Groups. <para> [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.InstanceInitiatedShutdownBehavior"> <summary> Gets and sets the property InstanceInitiatedShutdownBehavior. <para> Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.InstanceType"> <summary> Gets and sets the property InstanceType. <para> Changes the instance type to the specified value. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a>. If the instance type is not valid, the error returned is <code>InvalidInstanceAttributeValue</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Kernel"> <summary> Gets and sets the property Kernel. <para> Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Ramdisk"> <summary> Gets and sets the property Ramdisk. <para> Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Specifies whether source/destination checking is enabled. A value of <code>true</code> means that checking is enabled, and <code>false</code> means checking is disabled. This value must be <code>false</code> for a NAT instance to perform NAT. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. <para> Set to <code>simple</code> to enable enhanced networking for the instance. </para> <para> There is no way to disable enhanced networking at this time. </para> <para> This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.UserData"> <summary> Gets and sets the property UserData. <para> Changes the instance's user data to the specified value. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyInstanceAttributeRequest.Value"> <summary> Gets and sets the property Value. <para> A new value for the attribute. Use only with the <code>kernel</code>, <code>ramdisk</code>, <code>userData</code>, <code>disableApiTermination</code>, or <code>instanceInitiatedShutdownBehavior</code> attribute. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest"> <summary> Container for the parameters to the ModifyNetworkInterfaceAttribute operation. Modifies the specified network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.Attachment"> <summary> Gets and sets the property Attachment. <para> Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.Description"> <summary> Gets and sets the property Description. <para> A description for the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.Groups"> <summary> Gets and sets the property Groups. <para> Changes the security groups for the network interface. 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. You must specify the ID of the security group, not the name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyNetworkInterfaceAttributeRequest.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Indicates whether source/destination checking is enabled. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyReservedInstancesRequest"> <summary> Container for the parameters to the ModifyReservedInstances operation. Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html">Modifying Reserved Instances</a> in the Amazon Elastic Compute Cloud User Guide. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.ReservedInstancesIds"> <summary> Gets and sets the property ReservedInstancesIds. <para> The IDs of the Reserved Instances to modify. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesRequest.TargetConfigurations"> <summary> Gets and sets the property TargetConfigurations. <para> The configuration settings for the Reserved Instances to modify. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyReservedInstancesResponse"> <summary> Configuration for accessing Amazon ModifyReservedInstances service </summary> </member> <member name="T:Amazon.EC2.Model.ModifyReservedInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesResult.ReservedInstancesModificationId"> <summary> Gets and sets the property ReservedInstancesModificationId. <para> The ID for the modification. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyReservedInstancesResponse.ModifyReservedInstancesResult"> <summary> Gets and sets the ModifyReservedInstancesResult property. Represents the output of a ModifyReservedInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.ModifySnapshotAttributeRequest"> <summary> Container for the parameters to the ModifySnapshotAttribute operation. Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <note> <para> Snapshots with AWS Marketplace product codes cannot be made public. </para> </note> </summary> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ModifySnapshotAttributeRequest.#ctor(System.String,Amazon.EC2.SnapshotAttributeName,Amazon.EC2.OperationType)"> <summary> Instantiates ModifySnapshotAttributeRequest with the parameterized properties </summary> <param name="snapshotId">The ID of the snapshot.</param> <param name="attribute">The snapshot attribute to modify. <note> Only volume creation permissions may be modified at the customer level. </note></param> <param name="operationType">The type of operation to perform to the attribute.</param> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The snapshot attribute to modify. </para> <note> <para> Only volume creation permissions may be modified at the customer level. </para> </note> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.CreateVolumePermission"> <summary> Gets and sets the property CreateVolumePermission. <para> A JSON representation of the snapshot attribute modification. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.GroupNames"> <summary> Gets and sets the property GroupNames. <para> The group to modify for the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.OperationType"> <summary> Gets and sets the property OperationType. <para> The type of operation to perform to the attribute. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySnapshotAttributeRequest.UserIds"> <summary> Gets and sets the property UserIds. <para> The account ID to modify for the snapshot. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifySubnetAttributeRequest"> <summary> Container for the parameters to the ModifySubnetAttribute operation. Modifies a subnet attribute. </summary> </member> <member name="P:Amazon.EC2.Model.ModifySubnetAttributeRequest.MapPublicIpOnLaunch"> <summary> Gets and sets the property MapPublicIpOnLaunch. <para> Specify <code>true</code> to indicate that instances launched into the specified subnet should be assigned public IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifySubnetAttributeRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVolumeAttributeRequest"> <summary> Container for the parameters to the ModifyVolumeAttribute operation. Modifies a volume attribute. <para> By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. </para> <para> You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVolumeAttributeRequest.AutoEnableIO"> <summary> Gets and sets the property AutoEnableIO. <para> Indicates whether the volume should be auto-enabled for I/O operations. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVolumeAttributeRequest.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcAttributeRequest"> <summary> Container for the parameters to the ModifyVpcAttribute operation. Modifies the specified attribute of the specified VPC. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.EnableDnsHostnames"> <summary> Gets and sets the property EnableDnsHostnames. <para> Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. </para> <para> You can only enable DNS hostnames if you also enable DNS support. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.EnableDnsSupport"> <summary> Gets and sets the property EnableDnsSupport. <para> Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcAttributeRequest.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcEndpointRequest"> <summary> Container for the parameters to the ModifyVpcEndpoint operation. Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint. </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointRequest.AddRouteTableIds"> <summary> Gets and sets the property AddRouteTableIds. <para> One or more route tables IDs to associate with the endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointRequest.PolicyDocument"> <summary> Gets and sets the property PolicyDocument. <para> A policy document to attach to the endpoint. The policy must be in valid JSON format. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointRequest.RemoveRouteTableIds"> <summary> Gets and sets the property RemoveRouteTableIds. <para> One or more route table IDs to disassociate from the endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointRequest.ResetPolicy"> <summary> Gets and sets the property ResetPolicy. <para> Specify <code>true</code> to reset the policy document to the default policy. The default policy allows access to the service. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointRequest.VpcEndpointId"> <summary> Gets and sets the property VpcEndpointId. <para> The ID of the endpoint. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcEndpointResponse"> <summary> Configuration for accessing Amazon ModifyVpcEndpoint service </summary> </member> <member name="T:Amazon.EC2.Model.ModifyVpcEndpointResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ModifyVpcEndpointResponse.ModifyVpcEndpointResult"> <summary> Gets and sets the ModifyVpcEndpointResult property. Represents the output of a ModifyVpcEndpoint operation. </summary> </member> <member name="T:Amazon.EC2.Model.Monitoring"> <summary> Describes the monitoring for the instance. </summary> </member> <member name="P:Amazon.EC2.Model.Monitoring.State"> <summary> Gets and sets the property State. <para> Indicates whether monitoring is enabled for the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesRequest"> <summary> Container for the parameters to the MonitorInstances operation. Enables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.MonitorInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates MonitorInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesResponse"> <summary> Configuration for accessing Amazon MonitorInstances service </summary> </member> <member name="T:Amazon.EC2.Model.MonitorInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesResult.InstanceMonitorings"> <summary> Gets and sets the property InstanceMonitorings. <para> Monitoring information for one or more instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.MonitorInstancesResponse.MonitorInstancesResult"> <summary> Gets and sets the MonitorInstancesResult property. Represents the output of a MonitorInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.MoveAddressToVpcRequest"> <summary> Container for the parameters to the MoveAddressToVpc operation. Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the <a>RestoreAddressToClassic</a> request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform. </summary> </member> <member name="P:Amazon.EC2.Model.MoveAddressToVpcRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.MoveAddressToVpcResponse"> <summary> Configuration for accessing Amazon MoveAddressToVpc service </summary> </member> <member name="T:Amazon.EC2.Model.MoveAddressToVpcResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.MoveAddressToVpcResult.AllocationId"> <summary> Gets and sets the property AllocationId. <para> The allocation ID for the Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.MoveAddressToVpcResult.Status"> <summary> Gets and sets the property Status. <para> The status of the move of the IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.MoveAddressToVpcResponse.MoveAddressToVpcResult"> <summary> Gets and sets the MoveAddressToVpcResult property. Represents the output of a MoveAddressToVpc operation. </summary> </member> <member name="T:Amazon.EC2.Model.MovingAddressStatus"> <summary> Describes the status of a moving Elastic IP address. </summary> </member> <member name="P:Amazon.EC2.Model.MovingAddressStatus.MoveStatus"> <summary> Gets and sets the property MoveStatus. <para> The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform. </para> </summary> </member> <member name="P:Amazon.EC2.Model.MovingAddressStatus.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAcl"> <summary> Describes a network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Associations"> <summary> Gets and sets the property Associations. <para> Any associations between the network ACL and one or more subnets </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Entries"> <summary> Gets and sets the property Entries. <para> One or more entries (rules) in the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.IsDefault"> <summary> Gets and sets the property IsDefault. <para> Indicates whether this is the default network ACL for the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAcl.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC for the network ACL. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAclAssociation"> <summary> Describes an association between a network ACL and a subnet. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.NetworkAclAssociationId"> <summary> Gets and sets the property NetworkAclAssociationId. <para> The ID of the association between a network ACL and a subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the network ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclAssociation.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkAclEntry"> <summary> Describes an entry in a network ACL. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The network range to allow or deny, in CIDR notation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.Egress"> <summary> Gets and sets the property Egress. <para> Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.IcmpTypeCode"> <summary> Gets and sets the property IcmpTypeCode. <para> ICMP protocol: The ICMP type and code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.PortRange"> <summary> Gets and sets the property PortRange. <para> TCP or UDP protocols: The range of ports the rule applies to. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.Protocol"> <summary> Gets and sets the property Protocol. <para> The protocol. A value of <code>-1</code> means all protocols. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.RuleAction"> <summary> Gets and sets the property RuleAction. <para> Indicates whether to allow or deny the traffic that matches the rule. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkAclEntry.RuleNumber"> <summary> Gets and sets the property RuleNumber. <para> The rule number for the entry. ACL entries are processed in ascending order by rule number. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterface"> <summary> Describes a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Association"> <summary> Gets and sets the property Association. <para> The association information for an Elastic IP associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Attachment"> <summary> Gets and sets the property Attachment. <para> The network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Description"> <summary> Gets and sets the property Description. <para> A description. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Groups"> <summary> Gets and sets the property Groups. <para> Any security groups for the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.MacAddress"> <summary> Gets and sets the property MacAddress. <para> The MAC address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the owner of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The IP address of the network interface within the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> The private IP addresses associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.RequesterId"> <summary> Gets and sets the property RequesterId. <para> The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling). </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.RequesterManaged"> <summary> Gets and sets the property RequesterManaged. <para> Indicates whether the network interface is being managed by AWS. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> Indicates whether traffic to or from the instance is validated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.Status"> <summary> Gets and sets the property Status. <para> The status of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.TagSet"> <summary> Gets and sets the property TagSet. <para> Any tags assigned to the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterface.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAssociation"> <summary> Describes association information for an Elastic IP address. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.AllocationId"> <summary> Gets and sets the property AllocationId. <para> The allocation ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The association ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.IpOwnerId"> <summary> Gets and sets the property IpOwnerId. <para> The ID of the Elastic IP address owner. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.PublicDnsName"> <summary> Gets and sets the property PublicDnsName. <para> The public DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAssociation.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The address of the Elastic IP address bound to the network interface. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAttachment"> <summary> Describes a network interface attachment. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.AttachTime"> <summary> Gets and sets the property AttachTime. <para> The timestamp indicating when the attachment initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the network interface is deleted when the instance is terminated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.DeviceIndex"> <summary> Gets and sets the property DeviceIndex. <para> The device index of the network interface attachment on the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.InstanceOwnerId"> <summary> Gets and sets the property InstanceOwnerId. <para> The AWS account ID of the owner of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachment.Status"> <summary> Gets and sets the property Status. <para> The attachment state. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfaceAttachmentChanges"> <summary> Describes an attachment change. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachmentChanges.AttachmentId"> <summary> Gets and sets the property AttachmentId. <para> The ID of the network interface attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfaceAttachmentChanges.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the network interface is deleted when the instance is terminated. </para> </summary> </member> <member name="T:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress"> <summary> Describes the private IP address of a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.Association"> <summary> Gets and sets the property Association. <para> The association information for an Elastic IP address associated with the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.Primary"> <summary> Gets and sets the property Primary. <para> Indicates whether this IP address is the primary private IP address of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.PrivateDnsName"> <summary> Gets and sets the property PrivateDnsName. <para> The private DNS name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.NetworkInterfacePrivateIpAddress.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Placement"> <summary> Describes the placement for the instance. </summary> </member> <member name="M:Amazon.EC2.Model.Placement.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.Placement.#ctor(System.String)"> <summary> Instantiates Placement with the parameterized properties </summary> <param name="availabilityZone">The Availability Zone of the instance.</param> </member> <member name="P:Amazon.EC2.Model.Placement.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Placement.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the placement group the instance is in (for cluster compute instances). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Placement.Tenancy"> <summary> Gets and sets the property Tenancy. <para> The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PlacementGroup"> <summary> Describes a placement group. </summary> </member> <member name="M:Amazon.EC2.Model.PlacementGroup.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.PlacementGroup.#ctor(System.String)"> <summary> Instantiates PlacementGroup with the parameterized properties </summary> <param name="groupName">The name of the placement group.</param> </member> <member name="P:Amazon.EC2.Model.PlacementGroup.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the placement group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PlacementGroup.State"> <summary> Gets and sets the property State. <para> The state of the placement group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PlacementGroup.Strategy"> <summary> Gets and sets the property Strategy. <para> The placement strategy. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PortRange"> <summary> Describes a range of ports. </summary> </member> <member name="P:Amazon.EC2.Model.PortRange.From"> <summary> Gets and sets the property From. <para> The first port in the range. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PortRange.To"> <summary> Gets and sets the property To. <para> The last port in the range. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PrefixList"> <summary> Describes prefixes for AWS services. </summary> </member> <member name="P:Amazon.EC2.Model.PrefixList.Cidrs"> <summary> Gets and sets the property Cidrs. <para> The IP address range of the AWS service. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PrefixList.PrefixListId"> <summary> Gets and sets the property PrefixListId. <para> The ID of the prefix. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PrefixList.PrefixListName"> <summary> Gets and sets the property PrefixListName. <para> The name of the prefix. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PrefixListId"> <summary> The ID of the prefix. </summary> </member> <member name="P:Amazon.EC2.Model.PrefixListId.Id"> <summary> Gets and sets the property Id. <para> The ID of the prefix. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PriceSchedule"> <summary> Describes the price for a Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Active"> <summary> Gets and sets the property Active. <para> The current price schedule, as determined by the term remaining for the Reserved Instance in the listing. </para> <para> A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, 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 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.CurrencyCode"> <summary> Gets and sets the property CurrencyCode. <para> The currency for transacting the Reserved Instance resale. At this time, the only supported currency is <code>USD</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Price"> <summary> Gets and sets the property Price. <para> The fixed price for the term. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PriceSchedule.Term"> <summary> Gets and sets the property Term. <para> The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PriceScheduleSpecification"> <summary> Describes the price for a Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.PriceScheduleSpecification.CurrencyCode"> <summary> Gets and sets the property CurrencyCode. <para> The currency for transacting the Reserved Instance resale. At this time, the only supported currency is <code>USD</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PriceScheduleSpecification.Price"> <summary> Gets and sets the property Price. <para> The fixed price for the term. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PriceScheduleSpecification.Term"> <summary> Gets and sets the property Term. <para> The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PricingDetail"> <summary> Describes a Reserved Instance offering. </summary> </member> <member name="P:Amazon.EC2.Model.PricingDetail.Count"> <summary> Gets and sets the property Count. <para> The number of instances available for the price. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PricingDetail.Price"> <summary> Gets and sets the property Price. <para> The price per instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PrivateIpAddressSpecification"> <summary> Describes a secondary private IP address for a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.PrivateIpAddressSpecification.Primary"> <summary> Gets and sets the property Primary. <para> Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PrivateIpAddressSpecification.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> The private IP addresses. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ProductCode"> <summary> Describes a product code. </summary> </member> <member name="P:Amazon.EC2.Model.ProductCode.ProductCodeId"> <summary> Gets and sets the property ProductCodeId. <para> The product code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ProductCode.ProductCodeType"> <summary> Gets and sets the property ProductCodeType. <para> The type of product code. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PropagatingVgw"> <summary> Describes a virtual private gateway propagating route. </summary> </member> <member name="P:Amazon.EC2.Model.PropagatingVgw.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of the virtual private gateway (VGW). </para> </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest"> <summary> Container for the parameters to the PurchaseReservedInstancesOffering operation. Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing. <para> Use <a>DescribeReservedInstancesOfferings</a> to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with <a>DescribeReservedInstances</a>. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html">Reserved Instances</a> and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.#ctor(System.String,System.Int32)"> <summary> Instantiates PurchaseReservedInstancesOfferingRequest with the parameterized properties </summary> <param name="reservedInstancesOfferingId">The ID of the Reserved Instance offering to purchase.</param> <param name="instanceCount">The number of Reserved Instances to purchase.</param> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of Reserved Instances to purchase. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.LimitPrice"> <summary> Gets and sets the property LimitPrice. <para> Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingRequest.ReservedInstancesOfferingId"> <summary> Gets and sets the property ReservedInstancesOfferingId. <para> The ID of the Reserved Instance offering to purchase. </para> </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse"> <summary> Configuration for accessing Amazon PurchaseReservedInstancesOffering service </summary> </member> <member name="T:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResult.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> The IDs of the purchased Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.PurchaseReservedInstancesOfferingResponse.PurchaseReservedInstancesOfferingResult"> <summary> Gets and sets the PurchaseReservedInstancesOfferingResult property. Represents the output of a PurchaseReservedInstancesOffering operation. </summary> </member> <member name="T:Amazon.EC2.Model.RebootInstancesRequest"> <summary> Container for the parameters to the RebootInstances operation. Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. <para> If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Getting Console Output and Rebooting Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.RebootInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.RebootInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates RebootInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.RebootInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RecurringCharge"> <summary> Describes a recurring charge. </summary> </member> <member name="P:Amazon.EC2.Model.RecurringCharge.Amount"> <summary> Gets and sets the property Amount. <para> The amount of the recurring charge. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RecurringCharge.Frequency"> <summary> Gets and sets the property Frequency. <para> The frequency of the recurring charge. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Region"> <summary> Describes a region. </summary> </member> <member name="P:Amazon.EC2.Model.Region.Endpoint"> <summary> Gets and sets the property Endpoint. <para> The region service endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Region.RegionName"> <summary> Gets and sets the property RegionName. <para> The name of the region. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageRequest"> <summary> Container for the parameters to the RegisterImage operation. Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. <note> <para> For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself. </para> </note> <para> You can also use <code>RegisterImage</code> to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html">Launching an Instance from a Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <important> <para> Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 <code>billingProduct</code> code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. </para> <para> Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI. </para> <para> To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see <a>CreateImage</a>. </para> </important> <para> If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. </para> <note> <para> You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes. </para> </note> </summary> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.RegisterImageRequest.#ctor(System.String)"> <summary> Instantiates RegisterImageRequest with the parameterized properties </summary> <param name="imageLocation">The full path to your AMI manifest in Amazon S3 storage.</param> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Architecture"> <summary> Gets and sets the property Architecture. <para> The architecture of the AMI. </para> <para> Default: For Amazon EBS-backed AMIs, <code>i386</code>. For instance store-backed AMIs, the architecture specified in the manifest file. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> One or more block device mapping entries. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Description"> <summary> Gets and sets the property Description. <para> A description for your AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.ImageLocation"> <summary> Gets and sets the property ImageLocation. <para> The full path to your AMI manifest in Amazon S3 storage. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.Name"> <summary> Gets and sets the property Name. <para> A name for your AMI. </para> <para> Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_) </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.RootDeviceName"> <summary> Gets and sets the property RootDeviceName. <para> The name of the root device (for example, <code>/dev/sda1</code>, or <code>/dev/xvda</code>). </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.SriovNetSupport"> <summary> Gets and sets the property SriovNetSupport. <para> Set to <code>simple</code> to enable enhanced networking for the AMI and any instances that you launch from the AMI. </para> <para> There is no way to disable enhanced networking at this time. </para> <para> This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageRequest.VirtualizationType"> <summary> Gets and sets the property VirtualizationType. <para> The type of virtualization. </para> <para> Default: <code>paravirtual</code> </para> </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageResponse"> <summary> Configuration for accessing Amazon RegisterImage service </summary> </member> <member name="T:Amazon.EC2.Model.RegisterImageResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageResult.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the newly registered AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RegisterImageResponse.RegisterImageResult"> <summary> Gets and sets the RegisterImageResult property. Represents the output of a RegisterImage operation. </summary> </member> <member name="T:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest"> <summary> Container for the parameters to the RejectVpcPeeringConnection operation. Rejects a VPC peering connection request. The VPC peering connection must be in the <code>pending-acceptance</code> state. Use the <a>DescribeVpcPeeringConnections</a> request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use <a>DeleteVpcPeeringConnection</a>. </summary> </member> <member name="P:Amazon.EC2.Model.RejectVpcPeeringConnectionRequest.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of the VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RejectVpcPeeringConnectionResponse"> <summary> Returns information about the RejectVpcPeeringConnection response metadata. The RejectVpcPeeringConnection operation has a void result type. </summary> </member> <member name="T:Amazon.EC2.Model.ReleaseAddressRequest"> <summary> Container for the parameters to the ReleaseAddress operation. Releases the specified Elastic IP address. <para> After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account. </para> <para> [EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>. </para> <para> [Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>). </para> </summary> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ReleaseAddressRequest.#ctor(System.String)"> <summary> Instantiates ReleaseAddressRequest with the parameterized properties </summary> <param name="publicIp">[EC2-Classic] The Elastic IP address. Required for EC2-Classic.</param> </member> <member name="P:Amazon.EC2.Model.ReleaseAddressRequest.AllocationId"> <summary> Gets and sets the property AllocationId. <para> [EC2-VPC] The allocation ID. Required for EC2-VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReleaseAddressRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> [EC2-Classic] The Elastic IP address. Required for EC2-Classic. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest"> <summary> Container for the parameters to the ReplaceNetworkAclAssociation operation. Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The ID of the current association between the original network ACL and the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationRequest.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the new network ACL to associate with the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse"> <summary> Configuration for accessing Amazon ReplaceNetworkAclAssociation service </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationResult.NewAssociationId"> <summary> Gets and sets the property NewAssociationId. <para> The ID of the new association. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclAssociationResponse.ReplaceNetworkAclAssociationResult"> <summary> Gets and sets the ReplaceNetworkAclAssociationResult property. Represents the output of a ReplaceNetworkAclAssociation operation. </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest"> <summary> Container for the parameters to the ReplaceNetworkAclEntry operation. Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The network range to allow or deny, in CIDR notation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.Egress"> <summary> Gets and sets the property Egress. <para> Indicates whether to replace the egress rule. </para> <para> Default: If no value is specified, we replace the ingress rule. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.IcmpTypeCode"> <summary> Gets and sets the property IcmpTypeCode. <para> ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.NetworkAclId"> <summary> Gets and sets the property NetworkAclId. <para> The ID of the ACL. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.PortRange"> <summary> Gets and sets the property PortRange. <para> TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.Protocol"> <summary> Gets and sets the property Protocol. <para> The IP protocol. You can specify <code>all</code> or <code>-1</code> to mean all protocols. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.RuleAction"> <summary> Gets and sets the property RuleAction. <para> Indicates whether to allow or deny the traffic that matches the rule. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceNetworkAclEntryRequest.RuleNumber"> <summary> Gets and sets the property RuleNumber. <para> The rule number of the entry to replace. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteRequest"> <summary> Container for the parameters to the ReplaceRoute operation. Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface. <para> For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of an Internet gateway or virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of a NAT instance in your VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of a network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteRequest.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of a VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest"> <summary> Container for the parameters to the ReplaceRouteTableAssociation operation. Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. <para> You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.AssociationId"> <summary> Gets and sets the property AssociationId. <para> The association ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationRequest.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the new route table to associate with the subnet. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse"> <summary> Configuration for accessing Amazon ReplaceRouteTableAssociation service </summary> </member> <member name="T:Amazon.EC2.Model.ReplaceRouteTableAssociationResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationResult.NewAssociationId"> <summary> Gets and sets the property NewAssociationId. <para> The ID of the new association. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReplaceRouteTableAssociationResponse.ReplaceRouteTableAssociationResult"> <summary> Gets and sets the ReplaceRouteTableAssociationResult property. Represents the output of a ReplaceRouteTableAssociation operation. </summary> </member> <member name="T:Amazon.EC2.Model.ReportInstanceStatusRequest"> <summary> Container for the parameters to the ReportInstanceStatus operation. Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. <para> Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.Description"> <summary> Gets and sets the property Description. <para> Descriptive text about the health state of your instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.EndTime"> <summary> Gets and sets the property EndTime. <para> The time at which the reported instance health state ended. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.Instances"> <summary> Gets and sets the property Instances. <para> One or more instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.ReasonCodes"> <summary> Gets and sets the property ReasonCodes. <para> One or more reason codes that describes the health state of your instance. </para> <ul> <li> <para> <code>instance-stuck-in-state</code>: My instance is stuck in a state. </para> </li> <li> <para> <code>unresponsive</code>: My instance is unresponsive. </para> </li> <li> <para> <code>not-accepting-credentials</code>: My instance is not accepting my credentials. </para> </li> <li> <para> <code>password-not-available</code>: A password is not available for my instance. </para> </li> <li> <para> <code>performance-network</code>: My instance is experiencing performance problems which I believe are network related. </para> </li> <li> <para> <code>performance-instance-store</code>: My instance is experiencing performance problems which I believe are related to the instance stores. </para> </li> <li> <para> <code>performance-ebs-volume</code>: My instance is experiencing performance problems which I believe are related to an EBS volume. </para> </li> <li> <para> <code>performance-other</code>: My instance is experiencing performance problems. </para> </li> <li> <para> <code>other</code>: [explain using the description parameter] </para> </li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.StartTime"> <summary> Gets and sets the property StartTime. <para> The time at which the reported instance health state began. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReportInstanceStatusRequest.Status"> <summary> Gets and sets the property Status. <para> The status of all instances listed. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotFleetRequest"> <summary> Container for the parameters to the RequestSpotFleet operation. Creates a Spot fleet request. <para> You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. </para> <para> By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload. </para> <para> Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotFleetRequest.SpotFleetRequestConfig"> <summary> Gets and sets the property SpotFleetRequestConfig. <para> The configuration for the Spot fleet request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotFleetResponse"> <summary> Configuration for accessing Amazon RequestSpotFleet service </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotFleetResult"> <summary> Contains the output of RequestSpotFleet. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotFleetResult.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotFleetResponse.RequestSpotFleetResult"> <summary> Gets and sets the RequestSpotFleetResult property. Represents the output of a RequestSpotFleet operation. </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesRequest"> <summary> Container for the parameters to the RequestSpotInstances operation. Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.RequestSpotInstancesRequest.#ctor(System.String)"> <summary> Instantiates RequestSpotInstancesRequest with the parameterized properties </summary> <param name="spotPrice">The maximum hourly price (bid) for any Spot instance launched to fulfill the request.</param> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.AvailabilityZoneGroup"> <summary> Gets and sets the property AvailabilityZoneGroup. <para> The user-specified name for a logical grouping of bids. </para> <para> When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active. </para> <para> If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group. </para> <para> Default: Instances are launched in any available Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The maximum number of Spot instances to launch. </para> <para> Default: 1 </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.LaunchGroup"> <summary> Gets and sets the property LaunchGroup. <para> The instance launch group. Launch groups are Spot instances that launch together and terminate together. </para> <para> Default: Instances are launched and terminated individually </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.LaunchSpecification"> <summary> Gets and sets the property LaunchSpecification. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> The maximum hourly price (bid) for any Spot instance launched to fulfill the request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.Type"> <summary> Gets and sets the property Type. <para> The Spot instance request type. </para> <para> Default: <code>one-time</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.ValidFrom"> <summary> Gets and sets the property ValidFrom. <para> The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled. </para> <para> Default: The request is effective indefinitely. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesRequest.ValidUntil"> <summary> Gets and sets the property ValidUntil. <para> The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. </para> <para> Default: The request is effective indefinitely. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesResponse"> <summary> Configuration for accessing Amazon RequestSpotInstances service </summary> </member> <member name="T:Amazon.EC2.Model.RequestSpotInstancesResult"> <summary> Contains the output of RequestSpotInstances. </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesResult.SpotInstanceRequests"> <summary> Gets and sets the property SpotInstanceRequests. <para> One or more Spot instance requests. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RequestSpotInstancesResponse.RequestSpotInstancesResult"> <summary> Gets and sets the RequestSpotInstancesResult property. Represents the output of a RequestSpotInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.Reservation"> <summary> Describes a reservation. </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.GroupNames"> <summary> Gets and sets the property GroupNames. <para> One or more security group names. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.Groups"> <summary> Gets and sets the property Groups. <para> One or more security groups. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.Instances"> <summary> Gets and sets the property Instances. <para> One or more instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The ID of the AWS account that owns the reservation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.RequesterId"> <summary> Gets and sets the property RequesterId. <para> The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Reservation.ReservationId"> <summary> Gets and sets the property ReservationId. <para> The ID of the reservation. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstanceLimitPrice"> <summary> Describes the limit price of a Reserved Instance offering. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstanceLimitPrice.Amount"> <summary> Gets and sets the property Amount. <para> Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price). </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstanceLimitPrice.CurrencyCode"> <summary> Gets and sets the property CurrencyCode. <para> The currency in which the <code>limitPrice</code> amount is specified. At this time, the only supported currency is <code>USD</code>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstances"> <summary> Describes a Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which the Reserved Instance can be used. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.CurrencyCode"> <summary> Gets and sets the property CurrencyCode. <para> The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.Duration"> <summary> Gets and sets the property Duration. <para> The duration of the Reserved Instance, in seconds. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.End"> <summary> Gets and sets the property End. <para> The time when the Reserved Instance expires. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.FixedPrice"> <summary> Gets and sets the property FixedPrice. <para> The purchase price of the Reserved Instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of Reserved Instances purchased. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceTenancy"> <summary> Gets and sets the property InstanceTenancy. <para> The tenancy of the reserved instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type on which the Reserved Instance can be used. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.OfferingType"> <summary> Gets and sets the property OfferingType. <para> The Reserved Instance offering type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.ProductDescription"> <summary> Gets and sets the property ProductDescription. <para> The Reserved Instance product platform description. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.RecurringCharges"> <summary> Gets and sets the property RecurringCharges. <para> The recurring charge tag assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> The ID of the Reserved Instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.Start"> <summary> Gets and sets the property Start. <para> The date and time the Reserved Instance started. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.State"> <summary> Gets and sets the property State. <para> The state of the Reserved Instance purchase. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstances.UsagePrice"> <summary> Gets and sets the property UsagePrice. <para> The usage price of the Reserved Instance, per hour. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesConfiguration"> <summary> Describes the configuration settings for the modified Reserved Instances. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the modified Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.InstanceCount"> <summary> Gets and sets the property InstanceCount. <para> The number of modified Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type for the modified Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesConfiguration.Platform"> <summary> Gets and sets the property Platform. <para> The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesId"> <summary> Describes the ID of a Reserved Instance. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesId.Id"> <summary> Gets and sets the property Id. <para> The ID of the Reserved Instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesListing"> <summary> Describes a Reserved Instance listing. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ClientToken"> <summary> Gets and sets the property ClientToken. <para> A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.CreateDate"> <summary> Gets and sets the property CreateDate. <para> The time the listing was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.InstanceCounts"> <summary> Gets and sets the property InstanceCounts. <para> The number of instances in this state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.PriceSchedules"> <summary> Gets and sets the property PriceSchedules. <para> The price of the Reserved Instance listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> The ID of the Reserved Instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.ReservedInstancesListingId"> <summary> Gets and sets the property ReservedInstancesListingId. <para> The ID of the Reserved Instance listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.Status"> <summary> Gets and sets the property Status. <para> The status of the Reserved Instance listing. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> The reason for the current status of the Reserved Instance listing. The response can be blank. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesListing.UpdateDate"> <summary> Gets and sets the property UpdateDate. <para> The last modified timestamp of the listing. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesModification"> <summary> Describes a Reserved Instance modification. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ClientToken"> <summary> Gets and sets the property ClientToken. <para> A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.CreateDate"> <summary> Gets and sets the property CreateDate. <para> The time when the modification request was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.EffectiveDate"> <summary> Gets and sets the property EffectiveDate. <para> The time for the modification to become effective. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ModificationResults"> <summary> Gets and sets the property ModificationResults. <para> Contains target configurations along with their corresponding new Reserved Instance IDs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ReservedInstancesIds"> <summary> Gets and sets the property ReservedInstancesIds. <para> The IDs of one or more Reserved Instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.ReservedInstancesModificationId"> <summary> Gets and sets the property ReservedInstancesModificationId. <para> A unique ID for the Reserved Instance modification. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.Status"> <summary> Gets and sets the property Status. <para> The status of the Reserved Instances modification request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> The reason for the status. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModification.UpdateDate"> <summary> Gets and sets the property UpdateDate. <para> The time when the modification request was last updated. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesModificationResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModificationResult.ReservedInstancesId"> <summary> Gets and sets the property ReservedInstancesId. <para> The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesModificationResult.TargetConfiguration"> <summary> Gets and sets the property TargetConfiguration. <para> The target Reserved Instances configurations supplied as part of the modification request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ReservedInstancesOffering"> <summary> Describes a Reserved Instance offering. </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone in which the Reserved Instance can be used. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.CurrencyCode"> <summary> Gets and sets the property CurrencyCode. <para> The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is <code>USD</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.Duration"> <summary> Gets and sets the property Duration. <para> The duration of the Reserved Instance, in seconds. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.FixedPrice"> <summary> Gets and sets the property FixedPrice. <para> The purchase price of the Reserved Instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.InstanceTenancy"> <summary> Gets and sets the property InstanceTenancy. <para> The tenancy of the reserved instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type on which the Reserved Instance can be used. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.Marketplace"> <summary> Gets and sets the property Marketplace. <para> Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is <code>true</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.OfferingType"> <summary> Gets and sets the property OfferingType. <para> The Reserved Instance offering type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.PricingDetails"> <summary> Gets and sets the property PricingDetails. <para> The pricing details of the Reserved Instance offering. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.ProductDescription"> <summary> Gets and sets the property ProductDescription. <para> The Reserved Instance product platform description. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.RecurringCharges"> <summary> Gets and sets the property RecurringCharges. <para> The recurring charge tag assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.ReservedInstancesOfferingId"> <summary> Gets and sets the property ReservedInstancesOfferingId. <para> The ID of the Reserved Instance offering. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ReservedInstancesOffering.UsagePrice"> <summary> Gets and sets the property UsagePrice. <para> The usage price of the Reserved Instance, per hour. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ResetImageAttributeRequest"> <summary> Container for the parameters to the ResetImageAttribute operation. Resets an attribute of an AMI to its default value. <note> <para> The productCodes attribute can't be reset. </para> </note> </summary> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ResetImageAttributeRequest.#ctor(System.String,Amazon.EC2.ResetImageAttributeName)"> <summary> Instantiates ResetImageAttributeRequest with the parameterized properties </summary> <param name="imageId">The ID of the AMI.</param> <param name="attribute">The attribute to reset (currently you can only reset the launch permission attribute).</param> </member> <member name="P:Amazon.EC2.Model.ResetImageAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The attribute to reset (currently you can only reset the launch permission attribute). </para> </summary> </member> <member name="P:Amazon.EC2.Model.ResetImageAttributeRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ResetInstanceAttributeRequest"> <summary> Container for the parameters to the ResetInstanceAttribute operation. Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped. <para> The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ResetInstanceAttributeRequest.#ctor(System.String,Amazon.EC2.InstanceAttributeName)"> <summary> Instantiates ResetInstanceAttributeRequest with the parameterized properties </summary> <param name="instanceId">The ID of the instance.</param> <param name="attribute">The attribute to reset.</param> </member> <member name="P:Amazon.EC2.Model.ResetInstanceAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The attribute to reset. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ResetInstanceAttributeRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest"> <summary> Container for the parameters to the ResetNetworkInterfaceAttribute operation. Resets a network interface attribute. You can specify only one attribute at a time. </summary> </member> <member name="P:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ResetNetworkInterfaceAttributeRequest.SourceDestCheck"> <summary> Gets and sets the property SourceDestCheck. <para> The source/destination checking attribute. Resets the value to <code>true</code>. </para> </summary> </member> <member name="T:Amazon.EC2.Model.ResetSnapshotAttributeRequest"> <summary> Container for the parameters to the ResetSnapshotAttribute operation. Resets permission settings for the specified snapshot. <para> For more information on modifying snapshot permissions, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html">Sharing Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.ResetSnapshotAttributeRequest.#ctor(System.String,Amazon.EC2.SnapshotAttributeName)"> <summary> Instantiates ResetSnapshotAttributeRequest with the parameterized properties </summary> <param name="snapshotId">The ID of the snapshot.</param> <param name="attribute">The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.</param> </member> <member name="P:Amazon.EC2.Model.ResetSnapshotAttributeRequest.Attribute"> <summary> Gets and sets the property Attribute. <para> The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. </para> </summary> </member> <member name="P:Amazon.EC2.Model.ResetSnapshotAttributeRequest.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the snapshot. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RestoreAddressToClassicRequest"> <summary> Container for the parameters to the RestoreAddressToClassic operation. Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface. </summary> </member> <member name="P:Amazon.EC2.Model.RestoreAddressToClassicRequest.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RestoreAddressToClassicResponse"> <summary> Configuration for accessing Amazon RestoreAddressToClassic service </summary> </member> <member name="T:Amazon.EC2.Model.RestoreAddressToClassicResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.RestoreAddressToClassicResult.PublicIp"> <summary> Gets and sets the property PublicIp. <para> The Elastic IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RestoreAddressToClassicResult.Status"> <summary> Gets and sets the property Status. <para> The move status for the IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RestoreAddressToClassicResponse.RestoreAddressToClassicResult"> <summary> Gets and sets the RestoreAddressToClassicResult property. Represents the output of a RestoreAddressToClassic operation. </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest"> <summary> Container for the parameters to the RevokeSecurityGroupEgress operation. Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupEgressRequest.IpPermissions"> <summary> Gets and sets the property IpPermissions. <para> A set of IP permissions. You can't specify a destination security group and a CIDR IP address range. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest"> <summary> Container for the parameters to the RevokeSecurityGroupIngress operation. Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed. <para> Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. </para> <para> Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur. </para> </summary> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.#ctor(System.String,System.Collections.Generic.List{Amazon.EC2.Model.IpPermission})"> <summary> Instantiates RevokeSecurityGroupIngressRequest with the parameterized properties </summary> <param name="groupName">[EC2-Classic, default VPC] The name of the security group.</param> <param name="ipPermissions">A set of IP permissions. You can't specify a source security group and a CIDR IP address range.</param> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. Required for a security group in a nondefault VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.GroupName"> <summary> Gets and sets the property GroupName. <para> [EC2-Classic, default VPC] The name of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RevokeSecurityGroupIngressRequest.IpPermissions"> <summary> Gets and sets the property IpPermissions. <para> A set of IP permissions. You can't specify a source security group and a CIDR IP address range. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Route"> <summary> Describes a route in a route table. </summary> </member> <member name="P:Amazon.EC2.Model.Route.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR block used for the destination match. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.DestinationPrefixListId"> <summary> Gets and sets the property DestinationPrefixListId. <para> The prefix of the AWS service. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.GatewayId"> <summary> Gets and sets the property GatewayId. <para> The ID of a gateway attached to your VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of a NAT instance in your VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.InstanceOwnerId"> <summary> Gets and sets the property InstanceOwnerId. <para> The AWS account ID of the owner of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.Origin"> <summary> Gets and sets the property Origin. <para> Describes how the route was created. </para> <ul> <li> <code>CreateRouteTable</code> indicates that route was automatically created when the route table was created.</li> <li> <code>CreateRoute</code> indicates that the route was manually added to the route table.</li> <li> <code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation.</li> </ul> </summary> </member> <member name="P:Amazon.EC2.Model.Route.State"> <summary> Gets and sets the property State. <para> The state of the route. The <code>blackhole</code> state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Route.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of the VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RouteTable"> <summary> Describes a route table. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Associations"> <summary> Gets and sets the property Associations. <para> The associations between the route table and one or more subnets. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.PropagatingVgws"> <summary> Gets and sets the property PropagatingVgws. <para> Any virtual private gateway (VGW) propagating routes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Routes"> <summary> Gets and sets the property Routes. <para> The routes in the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTable.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RouteTableAssociation"> <summary> Describes an association between a route table and a subnet. </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.Main"> <summary> Gets and sets the property Main. <para> Indicates whether this is the main route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.RouteTableAssociationId"> <summary> Gets and sets the property RouteTableAssociationId. <para> The ID of the association between a route table and a subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.RouteTableId"> <summary> Gets and sets the property RouteTableId. <para> The ID of the route table. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RouteTableAssociation.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. A subnet ID is not returned for an implicit association. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesRequest"> <summary> Container for the parameters to the RunInstances operation. Launches the specified number of instances using an AMI for which you have permissions. <para> When you launch an instance, it enters the <code>pending</code> state. After the instance is ready for you, it enters the <code>running</code> state. To check the state of your instance, call <a>DescribeInstances</a>. </para> <para> If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html">Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> [EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you. </para> <para> [EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you. </para> <para> Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> You can provide optional user data when launching an instance. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> If any of the AMIs have a product code attached for which the user has not subscribed, <code>RunInstances</code> fails. </para> <para> T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, <code>RunInstances</code> fails. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html">What To Do If An Instance Immediately Terminates</a>, and <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html">Troubleshooting Connecting to Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.RunInstancesRequest.#ctor(System.String,System.Int32,System.Int32)"> <summary> Instantiates RunInstancesRequest with the parameterized properties </summary> <param name="imageId">The ID of the AMI, which you can get by calling <a>DescribeImages</a>.</param> <param name="minCount">The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ.</param> <param name="maxCount">The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above <code>MinCount</code>. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ.</param> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.AdditionalInfo"> <summary> Gets and sets the property AdditionalInfo. <para> Reserved. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> The block device mapping. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> <para> Constraints: Maximum 64 ASCII characters </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.DisableApiTermination"> <summary> Gets and sets the property DisableApiTermination. <para> If you set this parameter to <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to <code>true</code> and then later want to be able to terminate the instance, you must first change the value of the <code>disableApiTermination</code> attribute to <code>false</code> using <a>ModifyInstanceAttribute</a>. Alternatively, if you set <code>InstanceInitiatedShutdownBehavior</code> to <code>terminate</code>, you can terminate the instance by running the shutdown command from the instance. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The IAM instance profile. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI, which you can get by calling <a>DescribeImages</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.InstanceInitiatedShutdownBehavior"> <summary> Gets and sets the property InstanceInitiatedShutdownBehavior. <para> Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). </para> <para> Default: <code>stop</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> Default: <code>m1.small</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel. </para> <important> <para> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html"> PV-GRUB</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </important> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. You can create a key pair using <a>CreateKeyPair</a> or <a>ImportKeyPair</a>. </para> <important> <para> If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in. </para> </important> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.MaxCount"> <summary> Gets and sets the property MaxCount. <para> The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above <code>MinCount</code>. </para> <para> Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.MinCount"> <summary> Gets and sets the property MinCount. <para> The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances. </para> <para> Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see <a href="http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2">How many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.Monitoring"> <summary> Gets and sets the property Monitoring. <para> The monitoring for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.NetworkInterfaces"> <summary> Gets and sets the property NetworkInterfaces. <para> One or more network interfaces. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.Placement"> <summary> Gets and sets the property Placement. <para> The placement for the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.PrivateIpAddress"> <summary> Gets and sets the property PrivateIpAddress. <para> [EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet. </para> <para> Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if <code>PrivateIpAddresses.n.Primary</code> is set to <code>true</code> and <code>PrivateIpAddresses.n.PrivateIpAddress</code> is set to an IP address. </para> <para> Default: We select an IP address from the IP address range of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk. </para> <important> <para> We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html"> PV-GRUB</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </important> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SecurityGroupIds"> <summary> Gets and sets the property SecurityGroupIds. <para> One or more security group IDs. You can create a security group using <a>CreateSecurityGroup</a>. </para> <para> Default: Amazon EC2 uses the default security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. </para> <para> Default: Amazon EC2 uses the default security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.SubnetId"> <summary> Gets and sets the property SubnetId. <para> [EC2-VPC] The ID of the subnet to launch the instance into. </para> </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesRequest.UserData"> <summary> Gets and sets the property UserData. <para> The Base64-encoded MIME user data for the instances. </para> </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesResponse"> <summary> Configuration for accessing Amazon RunInstances service </summary> </member> <member name="T:Amazon.EC2.Model.RunInstancesResult"> <summary> Contains the response data from the RunInstances operation. </summary> </member> <member name="P:Amazon.EC2.Model.RunInstancesResponse.RunInstancesResult"> <summary> Gets and sets the RunInstancesResult property. Represents the output of a RunInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.S3Storage"> <summary> Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI. </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.AWSAccessKeyId"> <summary> Gets and sets the property AWSAccessKeyId. <para> The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in <a href="http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best Practices for Managing AWS Access Keys</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.Bucket"> <summary> Gets and sets the property Bucket. <para> 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. </para> </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.Prefix"> <summary> Gets and sets the property Prefix. <para> The beginning of the file name of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.UploadPolicy"> <summary> Gets and sets the property UploadPolicy. <para> A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. </para> </summary> </member> <member name="P:Amazon.EC2.Model.S3Storage.UploadPolicySignature"> <summary> Gets and sets the property UploadPolicySignature. <para> The signature of the Base64 encoded JSON document. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SecurityGroup"> <summary> Describes a security group </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.Description"> <summary> Gets and sets the property Description. <para> A description of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.IpPermissions"> <summary> Gets and sets the property IpPermissions. <para> One or more inbound rules associated with the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.IpPermissionsEgress"> <summary> Gets and sets the property IpPermissionsEgress. <para> [EC2-VPC] One or more outbound rules associated with the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the owner of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SecurityGroup.VpcId"> <summary> Gets and sets the property VpcId. <para> [EC2-VPC] The ID of the VPC for the security group. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Snapshot"> <summary> Describes a snapshot. </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.DataEncryptionKeyId"> <summary> Gets and sets the property DataEncryptionKeyId. <para> The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the <a>DescribeSnapshots</a> API operation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Description"> <summary> Gets and sets the property Description. <para> The description for the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Indicates whether the snapshot is encrypted. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.OwnerAlias"> <summary> Gets and sets the property OwnerAlias. <para> The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or AWS account ID that owns the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the EBS snapshot owner. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Progress"> <summary> Gets and sets the property Progress. <para> The progress of the snapshot, as a percentage. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The ID of the snapshot. Each snapshot receives a unique identifier when it is created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.StartTime"> <summary> Gets and sets the property StartTime. <para> The time stamp when the snapshot was initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.State"> <summary> Gets and sets the property State. <para> The snapshot state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.StateMessage"> <summary> Gets and sets the property StateMessage. <para> Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the <a>DescribeSnapshots</a> API operation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume that was used to create the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Snapshot.VolumeSize"> <summary> Gets and sets the property VolumeSize. <para> The size of the volume, in GiB. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SnapshotDetail"> <summary> Describes the snapshot created from the imported disk. </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.Description"> <summary> Gets and sets the property Description. <para> A description for the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.DeviceName"> <summary> Gets and sets the property DeviceName. <para> The block device mapping for the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.DiskImageSize"> <summary> Gets and sets the property DiskImageSize. <para> The size of the disk in the snapshot, in GiB. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.Format"> <summary> Gets and sets the property Format. <para> The format of the disk image from which the snapshot is created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.Progress"> <summary> Gets and sets the property Progress. <para> The percentage of progress for the task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot ID of the disk being imported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.Status"> <summary> Gets and sets the property Status. <para> A brief status of the snapshot creation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> A detailed status message for the snapshot creation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.Url"> <summary> Gets and sets the property Url. <para> The URL used to access the disk image. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDetail.UserBucket"> <summary> Gets and sets the property UserBucket. </summary> </member> <member name="T:Amazon.EC2.Model.SnapshotDiskContainer"> <summary> The disk container object for the import snapshot request. </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDiskContainer.Description"> <summary> Gets and sets the property Description. <para> The description of the disk image being imported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDiskContainer.Format"> <summary> Gets and sets the property Format. <para> The format of the disk image being imported. </para> <para> Valid values: <code>RAW</code> | <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDiskContainer.Url"> <summary> Gets and sets the property Url. <para> The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..). </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotDiskContainer.UserBucket"> <summary> Gets and sets the property UserBucket. </summary> </member> <member name="T:Amazon.EC2.Model.SnapshotTaskDetail"> <summary> Details about the import snapshot task. </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.Description"> <summary> Gets and sets the property Description. <para> The description of the snapshot. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.DiskImageSize"> <summary> Gets and sets the property DiskImageSize. <para> The size of the disk in the snapshot, in GiB. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.Format"> <summary> Gets and sets the property Format. <para> The format of the disk image from which the snapshot is created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.Progress"> <summary> Gets and sets the property Progress. <para> The percentage of completion for the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot ID of the disk being imported. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.Status"> <summary> Gets and sets the property Status. <para> A brief status for the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> A detailed status message for the import snapshot task. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.Url"> <summary> Gets and sets the property Url. <para> The URL of the disk image from which the snapshot is created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SnapshotTaskDetail.UserBucket"> <summary> Gets and sets the property UserBucket. <para> The S3 bucket for the disk image. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotDatafeedSubscription"> <summary> Describes the data feed for a Spot instance. </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Bucket"> <summary> Gets and sets the property Bucket. <para> The Amazon S3 bucket where the Spot instance data feed is located. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Fault"> <summary> Gets and sets the property Fault. <para> The fault codes for the Spot instance request, if any. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the account. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.Prefix"> <summary> Gets and sets the property Prefix. <para> The prefix that is prepended to data feed files. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotDatafeedSubscription.State"> <summary> Gets and sets the property State. <para> The state of the Spot instance data feed subscription. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotFleetLaunchSpecification"> <summary> Describes the launch specification for one or more Spot instances. </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.AddressingType"> <summary> Gets and sets the property AddressingType. <para> Deprecated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.BlockDeviceMappings"> <summary> Gets and sets the property BlockDeviceMappings. <para> One or more block device mapping entries. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.EbsOptimized"> <summary> Gets and sets the property EbsOptimized. <para> Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.IamInstanceProfile"> <summary> Gets and sets the property IamInstanceProfile. <para> The IAM instance profile. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.ImageId"> <summary> Gets and sets the property ImageId. <para> The ID of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.KernelId"> <summary> Gets and sets the property KernelId. <para> The ID of the kernel. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.KeyName"> <summary> Gets and sets the property KeyName. <para> The name of the key pair. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.Monitoring"> <summary> Gets and sets the property Monitoring. <para> Enable or disable monitoring for the instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.NetworkInterfaces"> <summary> Gets and sets the property NetworkInterfaces. <para> One or more network interfaces. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.Placement"> <summary> Gets and sets the property Placement. <para> The placement information. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.RamdiskId"> <summary> Gets and sets the property RamdiskId. <para> The ID of the RAM disk. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.SecurityGroups"> <summary> Gets and sets the property SecurityGroups. <para> One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of <code>WeightedCapacity</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet in which to launch the instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.UserData"> <summary> Gets and sets the property UserData. <para> The Base64-encoded MIME user data to make available to the instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetLaunchSpecification.WeightedCapacity"> <summary> Gets and sets the property WeightedCapacity. <para> The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O). </para> <para> If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotFleetMonitoring"> <summary> Describes whether monitoring is enabled. </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetMonitoring.Enabled"> <summary> Gets and sets the property Enabled. <para> Enables monitoring for the instance. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotFleetRequestConfig"> <summary> Describes a Spot fleet request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfig.ConfigData"> <summary> Gets and sets the property ConfigData. <para> Information about the configuration of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfig.SpotFleetRequestId"> <summary> Gets and sets the property SpotFleetRequestId. <para> The ID of the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfig.SpotFleetRequestState"> <summary> Gets and sets the property SpotFleetRequestState. <para> The state of the Spot fleet request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotFleetRequestConfigData"> <summary> Describes the configuration of a Spot fleet request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.AllocationStrategy"> <summary> Gets and sets the property AllocationStrategy. <para> Determines how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is <code>lowestPrice</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.ClientToken"> <summary> Gets and sets the property ClientToken. <para> A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.IamFleetRole"> <summary> Gets and sets the property IamFleetRole. <para> Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using <a>CancelSpotFleetRequests</a> or when the Spot fleet request expires, if you set <code>terminateInstancesWithExpiration</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.LaunchSpecifications"> <summary> Gets and sets the property LaunchSpecifications. <para> Information about the launch specifications for the Spot fleet request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> The bid price per unit hour. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.TargetCapacity"> <summary> Gets and sets the property TargetCapacity. <para> The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.TerminateInstancesWithExpiration"> <summary> Gets and sets the property TerminateInstancesWithExpiration. <para> Indicates whether running Spot instances should be terminated when the Spot fleet request expires. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.ValidFrom"> <summary> Gets and sets the property ValidFrom. <para> The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotFleetRequestConfigData.ValidUntil"> <summary> Gets and sets the property ValidUntil. <para> The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new Spot instance requests are placed or enabled to fulfill the request. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceRequest"> <summary> Describe a Spot instance request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.AvailabilityZoneGroup"> <summary> Gets and sets the property AvailabilityZoneGroup. <para> 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. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.CreateTime"> <summary> Gets and sets the property CreateTime. <para> The date and time when the Spot instance request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Fault"> <summary> Gets and sets the property Fault. <para> The fault codes for the Spot instance request, if any. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The instance ID, if an instance has been launched to fulfill the Spot instance request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchedAvailabilityZone"> <summary> Gets and sets the property LaunchedAvailabilityZone. <para> The Availability Zone in which the bid is launched. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchGroup"> <summary> Gets and sets the property LaunchGroup. <para> The instance launch group. Launch groups are Spot instances that launch together and terminate together. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.LaunchSpecification"> <summary> Gets and sets the property LaunchSpecification. <para> Additional information for launching instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ProductDescription"> <summary> Gets and sets the property ProductDescription. <para> The product description associated with the Spot instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.SpotInstanceRequestId"> <summary> Gets and sets the property SpotInstanceRequestId. <para> The ID of the Spot instance request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.SpotPrice"> <summary> Gets and sets the property SpotPrice. <para> The maximum hourly price (bid) for any Spot instance launched to fulfill the request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.State"> <summary> Gets and sets the property State. <para> The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html">Spot Bid Status</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Status"> <summary> Gets and sets the property Status. <para> The status code and status message describing the Spot instance request. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.Type"> <summary> Gets and sets the property Type. <para> The Spot instance request type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ValidFrom"> <summary> Gets and sets the property ValidFrom. <para> The start date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceRequest.ValidUntil"> <summary> Gets and sets the property ValidUntil. <para> The end date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceStateFault"> <summary> Describes a Spot instance state change. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStateFault.Code"> <summary> Gets and sets the property Code. <para> The reason code for the Spot instance state change. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStateFault.Message"> <summary> Gets and sets the property Message. <para> The message for the Spot instance state change. </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotInstanceStatus"> <summary> Describes the status of a Spot instance request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatus.Code"> <summary> Gets and sets the property Code. <para> The status code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatus.Message"> <summary> Gets and sets the property Message. <para> The description for the status code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotInstanceStatus.UpdateTime"> <summary> Gets and sets the property UpdateTime. <para> The date and time of the most recent status update, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotPlacement"> <summary> Describes Spot instance placement. </summary> </member> <member name="M:Amazon.EC2.Model.SpotPlacement.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.SpotPlacement.#ctor(System.String)"> <summary> Instantiates SpotPlacement with the parameterized properties </summary> <param name="availabilityZone">The Availability Zone.</param> </member> <member name="P:Amazon.EC2.Model.SpotPlacement.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotPlacement.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the placement group (for cluster instances). </para> </summary> </member> <member name="T:Amazon.EC2.Model.SpotPrice"> <summary> Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request. </summary> </member> <member name="P:Amazon.EC2.Model.SpotPrice.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotPrice.InstanceType"> <summary> Gets and sets the property InstanceType. <para> The instance type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotPrice.Price"> <summary> Gets and sets the property Price. <para> The maximum price (bid) that you are willing to pay for a Spot instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotPrice.ProductDescription"> <summary> Gets and sets the property ProductDescription. <para> A general description of the AMI. </para> </summary> </member> <member name="P:Amazon.EC2.Model.SpotPrice.Timestamp"> <summary> Gets and sets the property Timestamp. <para> The date and time the request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). </para> </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesRequest"> <summary> Container for the parameters to the StartInstances operation. Starts an Amazon EBS-backed AMI that you've previously stopped. <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html">Stopping Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.StartInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.StartInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates StartInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.StartInstancesRequest.AdditionalInfo"> <summary> Gets and sets the property AdditionalInfo. <para> Reserved. </para> </summary> </member> <member name="P:Amazon.EC2.Model.StartInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesResponse"> <summary> Configuration for accessing Amazon StartInstances service </summary> </member> <member name="T:Amazon.EC2.Model.StartInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.StartInstancesResult.StartingInstances"> <summary> Gets and sets the property StartingInstances. <para> Information about one or more started instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.StartInstancesResponse.StartInstancesResult"> <summary> Gets and sets the StartInstancesResult property. Represents the output of a StartInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.StateReason"> <summary> Describes a state change. </summary> </member> <member name="P:Amazon.EC2.Model.StateReason.Code"> <summary> Gets and sets the property Code. <para> The reason code for the state change. </para> </summary> </member> <member name="P:Amazon.EC2.Model.StateReason.Message"> <summary> Gets and sets the property Message. <para> The message for the state change. </para> <ul> <li> <para> <code>Server.SpotInstanceTermination</code>: A Spot Instance was terminated due to an increase in the market price. </para> </li> <li> <para> <code>Server.InternalError</code>: An internal error occurred during instance launch, resulting in termination. </para> </li> <li> <para> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient instance capacity to satisfy the launch request. </para> </li> <li> <para> <code>Client.InternalError</code>: A client error caused the instance to terminate on launch. </para> </li> <li> <para> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down using the <code>shutdown -h</code> command from the instance. </para> </li> <li> <para> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API. </para> </li> <li> <para> <code>Client.VolumeLimitExceeded</code>: The volume limit was exceeded. </para> </li> <li> <para> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found. </para> </li> </ul> </summary> </member> <member name="T:Amazon.EC2.Model.StopInstancesRequest"> <summary> Container for the parameters to the StopInstances operation. Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour. <para> You can't start or stop Spot Instances. </para> <para> Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. </para> <para> Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM. </para> <para> Performing this operation on an instance that uses an instance store as its root device returns an error. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html">Troubleshooting Stopping Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.StopInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates StopInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.StopInstancesRequest.Force"> <summary> Gets and sets the property Force. <para> Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. </para> <para> Default: <code>false</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.StopInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.StopInstancesResponse"> <summary> Configuration for accessing Amazon StopInstances service </summary> </member> <member name="T:Amazon.EC2.Model.StopInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.StopInstancesResult.StoppingInstances"> <summary> Gets and sets the property StoppingInstances. <para> Information about one or more stopped instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.StopInstancesResponse.StopInstancesResult"> <summary> Gets and sets the StopInstancesResult property. Represents the output of a StopInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.Storage"> <summary> Describes the storage location for an instance store-backed AMI. </summary> </member> <member name="P:Amazon.EC2.Model.Storage.S3"> <summary> Gets and sets the property S3. <para> An Amazon S3 storage location. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Subnet"> <summary> Describes a subnet. </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.AvailableIpAddressCount"> <summary> Gets and sets the property AvailableIpAddressCount. <para> The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The CIDR block assigned to the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.DefaultForAz"> <summary> Gets and sets the property DefaultForAz. <para> Indicates whether this is the default subnet for the Availability Zone. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.MapPublicIpOnLaunch"> <summary> Gets and sets the property MapPublicIpOnLaunch. <para> Indicates whether instances launched in this subnet receive a public IP address. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.State"> <summary> Gets and sets the property State. <para> The current state of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.SubnetId"> <summary> Gets and sets the property SubnetId. <para> The ID of the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the subnet. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Subnet.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC the subnet is in. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Tag"> <summary> Describes a tag. </summary> </member> <member name="M:Amazon.EC2.Model.Tag.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.Tag.#ctor(System.String,System.String)"> <summary> Instantiates Tag with the parameterized properties </summary> <param name="key">The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code></param> <param name="value">The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.</param> </member> <member name="M:Amazon.EC2.Model.Tag.#ctor(System.String)"> <summary> Instantiates Tag with the parameterized properties </summary> <param name="key">The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code></param> </member> <member name="P:Amazon.EC2.Model.Tag.Key"> <summary> Gets and sets the property Key. <para> The key of the tag. </para> <para> Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code> </para> </summary> </member> <member name="P:Amazon.EC2.Model.Tag.Value"> <summary> Gets and sets the property Value. <para> The value of the tag. </para> <para> Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters. </para> </summary> </member> <member name="T:Amazon.EC2.Model.TagDescription"> <summary> Describes a tag. </summary> </member> <member name="P:Amazon.EC2.Model.TagDescription.Key"> <summary> Gets and sets the property Key. <para> The tag key. </para> </summary> </member> <member name="P:Amazon.EC2.Model.TagDescription.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource. For example, <code>ami-1a2b3c4d</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.TagDescription.ResourceType"> <summary> Gets and sets the property ResourceType. <para> The resource type. </para> </summary> </member> <member name="P:Amazon.EC2.Model.TagDescription.Value"> <summary> Gets and sets the property Value. <para> The tag value. </para> </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesRequest"> <summary> Container for the parameters to the TerminateInstances operation. Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. <para> Terminated instances remain visible after termination (for approximately one hour). </para> <para> By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running. </para> <para> You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the <code>DeleteOnTermination</code> block device mapping parameter set to <code>true</code> are automatically deleted. For more information about the differences between stopping and terminating instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> For more information about troubleshooting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> </summary> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.TerminateInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates TerminateInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesResponse"> <summary> Configuration for accessing Amazon TerminateInstances service </summary> </member> <member name="T:Amazon.EC2.Model.TerminateInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesResult.TerminatingInstances"> <summary> Gets and sets the property TerminatingInstances. <para> Information about one or more terminated instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.TerminateInstancesResponse.TerminateInstancesResult"> <summary> Gets and sets the TerminateInstancesResult property. Represents the output of a TerminateInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest"> <summary> Container for the parameters to the UnassignPrivateIpAddresses operation. Unassigns one or more secondary private IP addresses from a network interface. </summary> </member> <member name="P:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.NetworkInterfaceId"> <summary> Gets and sets the property NetworkInterfaceId. <para> The ID of the network interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UnassignPrivateIpAddressesRequest.PrivateIpAddresses"> <summary> Gets and sets the property PrivateIpAddresses. <para> The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesRequest"> <summary> Container for the parameters to the UnmonitorInstances operation. Disables monitoring for a running instance. For more information about monitoring instances, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html">Monitoring Your Instances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </summary> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.EC2.Model.UnmonitorInstancesRequest.#ctor(System.Collections.Generic.List{System.String})"> <summary> Instantiates UnmonitorInstancesRequest with the parameterized properties </summary> <param name="instanceIds">One or more instance IDs.</param> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesRequest.InstanceIds"> <summary> Gets and sets the property InstanceIds. <para> One or more instance IDs. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesResponse"> <summary> Configuration for accessing Amazon UnmonitorInstances service </summary> </member> <member name="T:Amazon.EC2.Model.UnmonitorInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesResult.InstanceMonitorings"> <summary> Gets and sets the property InstanceMonitorings. <para> Monitoring information for one or more instances. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UnmonitorInstancesResponse.UnmonitorInstancesResult"> <summary> Gets and sets the UnmonitorInstancesResult property. Represents the output of a UnmonitorInstances operation. </summary> </member> <member name="T:Amazon.EC2.Model.UnsuccessfulItem"> <summary> Information about items that were not successfully processed in a batch call. </summary> </member> <member name="P:Amazon.EC2.Model.UnsuccessfulItem.Error"> <summary> Gets and sets the property Error. <para> Information about the error. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UnsuccessfulItem.ResourceId"> <summary> Gets and sets the property ResourceId. <para> The ID of the resource. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UnsuccessfulItemError"> <summary> Information about the error that occurred. For more information about errors, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html">Error Codes</a>. </summary> </member> <member name="P:Amazon.EC2.Model.UnsuccessfulItemError.Code"> <summary> Gets and sets the property Code. <para> The error code. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UnsuccessfulItemError.Message"> <summary> Gets and sets the property Message. <para> The error message accompanying the error code. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UserBucket"> <summary> Describes the S3 bucket for the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.UserBucket.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The name of the S3 bucket where the disk image is located. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UserBucket.S3Key"> <summary> Gets and sets the property S3Key. <para> The key for the disk image. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UserBucketDetails"> <summary> Describes the S3 bucket for the disk image. </summary> </member> <member name="P:Amazon.EC2.Model.UserBucketDetails.S3Bucket"> <summary> Gets and sets the property S3Bucket. <para> The S3 bucket from which the disk image was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UserBucketDetails.S3Key"> <summary> Gets and sets the property S3Key. <para> The key from which the disk image was created. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UserData"> <summary> Describes the user data to be made available to an instance. </summary> </member> <member name="P:Amazon.EC2.Model.UserData.Data"> <summary> Gets and sets the property Data. <para> The Base64-encoded MIME user data for the instance. </para> </summary> </member> <member name="T:Amazon.EC2.Model.UserIdGroupPair"> <summary> Describes a security group and AWS account ID pair. </summary> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.GroupId"> <summary> Gets and sets the property GroupId. <para> The ID of the security group. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.GroupName"> <summary> Gets and sets the property GroupName. <para> The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use <code>GroupId</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.UserIdGroupPair.UserId"> <summary> Gets and sets the property UserId. <para> The ID of an AWS account. EC2-Classic only. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VgwTelemetry"> <summary> Describes telemetry for a VPN tunnel. </summary> </member> <member name="P:Amazon.EC2.Model.VgwTelemetry.AcceptedRouteCount"> <summary> Gets and sets the property AcceptedRouteCount. <para> The number of accepted routes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VgwTelemetry.LastStatusChange"> <summary> Gets and sets the property LastStatusChange. <para> The date and time of the last change in status. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VgwTelemetry.OutsideIpAddress"> <summary> Gets and sets the property OutsideIpAddress. <para> The Internet-routable IP address of the virtual private gateway's outside interface. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VgwTelemetry.Status"> <summary> Gets and sets the property Status. <para> The status of the VPN tunnel. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VgwTelemetry.StatusMessage"> <summary> Gets and sets the property StatusMessage. <para> If an error occurs, a description of the error. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Volume"> <summary> Describes a volume. </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Attachments"> <summary> Gets and sets the property Attachments. <para> Information about the volume attachments. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone for the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.CreateTime"> <summary> Gets and sets the property CreateTime. <para> The time stamp when volume creation was initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Encrypted"> <summary> Gets and sets the property Encrypted. <para> Indicates whether the volume will be encrypted. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Iops"> <summary> Gets and sets the property Iops. <para> The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </para> <para> Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes. </para> <para> Condition: This parameter is required for requests to create <code>io1</code> volumes; it is not used in requests to create <code>standard</code> or <code>gp2</code> volumes. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.KmsKeyId"> <summary> Gets and sets the property KmsKeyId. <para> The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Size"> <summary> Gets and sets the property Size. <para> The size of the volume, in GiBs. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.SnapshotId"> <summary> Gets and sets the property SnapshotId. <para> The snapshot from which the volume was created, if applicable. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.State"> <summary> Gets and sets the property State. <para> The volume state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Volume.VolumeType"> <summary> Gets and sets the property VolumeType. <para> The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeAttachment"> <summary> Describes volume attachment details. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.AttachTime"> <summary> Gets and sets the property AttachTime. <para> The time stamp when the attachment initiated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.DeleteOnTermination"> <summary> Gets and sets the property DeleteOnTermination. <para> Indicates whether the EBS volume is deleted on instance termination. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.Device"> <summary> Gets and sets the property Device. <para> The device name. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.InstanceId"> <summary> Gets and sets the property InstanceId. <para> The ID of the instance. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.State"> <summary> Gets and sets the property State. <para> The attachment state of the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeAttachment.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The ID of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeDetail"> <summary> Describes an EBS volume. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeDetail.Size"> <summary> Gets and sets the property Size. <para> The size of the volume, in GiB. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusAction"> <summary> Describes a volume status operation code. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.Code"> <summary> Gets and sets the property Code. <para> The code identifying the operation, for example, <code>enable-volume-io</code>. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.Description"> <summary> Gets and sets the property Description. <para> A description of the operation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.EventId"> <summary> Gets and sets the property EventId. <para> The ID of the event associated with this operation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusAction.EventType"> <summary> Gets and sets the property EventType. <para> The event type associated with this operation. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusDetails"> <summary> Describes a volume status. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusDetails.Name"> <summary> Gets and sets the property Name. <para> The name of the volume status. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusDetails.Status"> <summary> Gets and sets the property Status. <para> The intended status of the volume status. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusEvent"> <summary> Describes a volume status event. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.Description"> <summary> Gets and sets the property Description. <para> A description of the event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.EventId"> <summary> Gets and sets the property EventId. <para> The ID of this event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.EventType"> <summary> Gets and sets the property EventType. <para> The type of this event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.NotAfter"> <summary> Gets and sets the property NotAfter. <para> The latest end time of the event. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusEvent.NotBefore"> <summary> Gets and sets the property NotBefore. <para> The earliest start time of the event. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusInfo"> <summary> Describes the status of a volume. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusInfo.Details"> <summary> Gets and sets the property Details. <para> The details of the volume status. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusInfo.Status"> <summary> Gets and sets the property Status. <para> The status of the volume. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VolumeStatusItem"> <summary> Describes the volume status. </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusItem.Actions"> <summary> Gets and sets the property Actions. <para> The details of the operation. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusItem.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone of the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusItem.Events"> <summary> Gets and sets the property Events. <para> A list of events associated with the volume. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusItem.VolumeId"> <summary> Gets and sets the property VolumeId. <para> The volume ID. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VolumeStatusItem.VolumeStatus"> <summary> Gets and sets the property VolumeStatus. <para> The volume status. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Vpc"> <summary> Describes a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The CIDR block for the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.DhcpOptionsId"> <summary> Gets and sets the property DhcpOptionsId. <para> The ID of the set of DHCP options you've associated with the VPC (or <code>default</code> if the default options are associated with the VPC). </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.InstanceTenancy"> <summary> Gets and sets the property InstanceTenancy. <para> The allowed tenancy of instances launched into the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.IsDefault"> <summary> Gets and sets the property IsDefault. <para> Indicates whether the VPC is the default VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.State"> <summary> Gets and sets the property State. <para> The current state of the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.Vpc.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcAttachment"> <summary> Describes an attachment between a virtual private gateway and a VPC. </summary> </member> <member name="P:Amazon.EC2.Model.VpcAttachment.State"> <summary> Gets and sets the property State. <para> The current state of the attachment. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcAttachment.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcClassicLink"> <summary> Describes whether a VPC is enabled for ClassicLink. </summary> </member> <member name="P:Amazon.EC2.Model.VpcClassicLink.ClassicLinkEnabled"> <summary> Gets and sets the property ClassicLinkEnabled. <para> Indicates whether the VPC is enabled for ClassicLink. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcClassicLink.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcClassicLink.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcEndpoint"> <summary> Describes a VPC endpoint. </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.CreationTimestamp"> <summary> Gets and sets the property CreationTimestamp. <para> The date and time the VPC endpoint was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.PolicyDocument"> <summary> Gets and sets the property PolicyDocument. <para> The policy document associated with the endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.RouteTableIds"> <summary> Gets and sets the property RouteTableIds. <para> One or more route tables associated with the endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.ServiceName"> <summary> Gets and sets the property ServiceName. <para> The name of the AWS service to which the endpoint is associated. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.State"> <summary> Gets and sets the property State. <para> The state of the VPC endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.VpcEndpointId"> <summary> Gets and sets the property VpcEndpointId. <para> The ID of the VPC endpoint. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcEndpoint.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC to which the endpoint is associated. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnection"> <summary> Describes a VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.AccepterVpcInfo"> <summary> Gets and sets the property AccepterVpcInfo. <para> The information of the peer VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.ExpirationTime"> <summary> Gets and sets the property ExpirationTime. <para> The time that an unaccepted VPC peering connection will expire. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.RequesterVpcInfo"> <summary> Gets and sets the property RequesterVpcInfo. <para> The information of the requester VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.Status"> <summary> Gets and sets the property Status. <para> The status of the VPC peering connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the resource. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnection.VpcPeeringConnectionId"> <summary> Gets and sets the property VpcPeeringConnectionId. <para> The ID of the VPC peering connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnectionStateReason"> <summary> Describes the status of a VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionStateReason.Code"> <summary> Gets and sets the property Code. <para> The status of the VPC peering connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionStateReason.Message"> <summary> Gets and sets the property Message. <para> A message that provides more information about the status, if applicable. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo"> <summary> Describes a VPC in a VPC peering connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.CidrBlock"> <summary> Gets and sets the property CidrBlock. <para> The CIDR block for the VPC. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.OwnerId"> <summary> Gets and sets the property OwnerId. <para> The AWS account ID of the VPC owner. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpcPeeringConnectionVpcInfo.VpcId"> <summary> Gets and sets the property VpcId. <para> The ID of the VPC. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpnConnection"> <summary> Describes a VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.CustomerGatewayConfiguration"> <summary> Gets and sets the property CustomerGatewayConfiguration. <para> The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the <a>CreateVpnConnection</a> response; however, it's present in the <a>DescribeVpnConnections</a> response only if the VPN connection is in the <code>pending</code> or <code>available</code> state. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.CustomerGatewayId"> <summary> Gets and sets the property CustomerGatewayId. <para> The ID of the customer gateway at your end of the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Options"> <summary> Gets and sets the property Options. <para> The VPN connection options. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Routes"> <summary> Gets and sets the property Routes. <para> The static routes associated with the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.State"> <summary> Gets and sets the property State. <para> The current state of the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VgwTelemetry"> <summary> Gets and sets the property VgwTelemetry. <para> Information about the VPN tunnel. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VpnConnectionId"> <summary> Gets and sets the property VpnConnectionId. <para> The ID of the VPN connection. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnection.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway at the AWS side of the VPN connection. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpnConnectionOptions"> <summary> Describes VPN connection options. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnectionOptions.StaticRoutesOnly"> <summary> Gets and sets the property StaticRoutesOnly. <para> Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpnConnectionOptionsSpecification"> <summary> Describes VPN connection options. </summary> </member> <member name="P:Amazon.EC2.Model.VpnConnectionOptionsSpecification.StaticRoutesOnly"> <summary> Gets and sets the property StaticRoutesOnly. <para> Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpnGateway"> <summary> Describes a virtual private gateway. </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.AvailabilityZone"> <summary> Gets and sets the property AvailabilityZone. <para> The Availability Zone where the virtual private gateway was created. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.State"> <summary> Gets and sets the property State. <para> The current state of the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.Tags"> <summary> Gets and sets the property Tags. <para> Any tags assigned to the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.Type"> <summary> Gets and sets the property Type. <para> The type of VPN connection the virtual private gateway supports. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.VpcAttachments"> <summary> Gets and sets the property VpcAttachments. <para> Any VPCs attached to the virtual private gateway. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnGateway.VpnGatewayId"> <summary> Gets and sets the property VpnGatewayId. <para> The ID of the virtual private gateway. </para> </summary> </member> <member name="T:Amazon.EC2.Model.VpnStaticRoute"> <summary> Describes a static route for a VPN connection. </summary> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.DestinationCidrBlock"> <summary> Gets and sets the property DestinationCidrBlock. <para> The CIDR block associated with the local subnet of the customer data center. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.Source"> <summary> Gets and sets the property Source. <para> Indicates how the routes were provided. </para> </summary> </member> <member name="P:Amazon.EC2.Model.VpnStaticRoute.State"> <summary> Gets and sets the property State. <para> The current state of the static route. </para> </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AcceptVpcPeeringConnectionRequestMarshaller"> <summary> AcceptVpcPeeringConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AcceptVpcPeeringConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for AcceptVpcPeeringConnection operation </summary> </member> <member name="T:Amazon.Runtime.Internal.Transform.EC2ResponseUnmarshaller"> <summary> Class for unmarshalling EC2 service responses. </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AccountAttributeUnmarshaller"> <summary> Response Unmarshaller for AccountAttribute Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AccountAttributeValueUnmarshaller"> <summary> Response Unmarshaller for AccountAttributeValue Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ActiveInstanceUnmarshaller"> <summary> Response Unmarshaller for ActiveInstance Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AddressUnmarshaller"> <summary> Response Unmarshaller for Address Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AllocateAddressRequestMarshaller"> <summary> AllocateAddress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AllocateAddressResponseUnmarshaller"> <summary> Response Unmarshaller for AllocateAddress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssignPrivateIpAddressesRequestMarshaller"> <summary> AssignPrivateIpAddresses Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssignPrivateIpAddressesResponseUnmarshaller"> <summary> Response Unmarshaller for AssignPrivateIpAddresses operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateAddressRequestMarshaller"> <summary> AssociateAddress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateAddressResponseUnmarshaller"> <summary> Response Unmarshaller for AssociateAddress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateDhcpOptionsRequestMarshaller"> <summary> AssociateDhcpOptions Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateDhcpOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for AssociateDhcpOptions operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateRouteTableRequestMarshaller"> <summary> AssociateRouteTable Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AssociateRouteTableResponseUnmarshaller"> <summary> Response Unmarshaller for AssociateRouteTable operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachClassicLinkVpcRequestMarshaller"> <summary> AttachClassicLinkVpc Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachClassicLinkVpcResponseUnmarshaller"> <summary> Response Unmarshaller for AttachClassicLinkVpc operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachInternetGatewayRequestMarshaller"> <summary> AttachInternetGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachInternetGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for AttachInternetGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachNetworkInterfaceRequestMarshaller"> <summary> AttachNetworkInterface Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachNetworkInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for AttachNetworkInterface operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachVolumeRequestMarshaller"> <summary> AttachVolume Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachVolumeResponseUnmarshaller"> <summary> Response Unmarshaller for AttachVolume operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachVpnGatewayRequestMarshaller"> <summary> AttachVpnGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AttachVpnGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for AttachVpnGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AuthorizeSecurityGroupEgressRequestMarshaller"> <summary> AuthorizeSecurityGroupEgress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AuthorizeSecurityGroupEgressResponseUnmarshaller"> <summary> Response Unmarshaller for AuthorizeSecurityGroupEgress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AuthorizeSecurityGroupIngressRequestMarshaller"> <summary> AuthorizeSecurityGroupIngress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AuthorizeSecurityGroupIngressResponseUnmarshaller"> <summary> Response Unmarshaller for AuthorizeSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AvailabilityZoneMessageUnmarshaller"> <summary> Response Unmarshaller for AvailabilityZoneMessage Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.AvailabilityZoneUnmarshaller"> <summary> Response Unmarshaller for AvailabilityZone Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.BlockDeviceMappingUnmarshaller"> <summary> Response Unmarshaller for BlockDeviceMapping Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.BundleInstanceRequestMarshaller"> <summary> BundleInstance Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.BundleInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for BundleInstance operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.BundleTaskErrorUnmarshaller"> <summary> Response Unmarshaller for BundleTaskError Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.BundleTaskUnmarshaller"> <summary> Response Unmarshaller for BundleTask Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelBundleTaskRequestMarshaller"> <summary> CancelBundleTask Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelBundleTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CancelBundleTask operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelConversionTaskRequestMarshaller"> <summary> CancelConversionTask Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelConversionTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CancelConversionTask operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelExportTaskRequestMarshaller"> <summary> CancelExportTask Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelExportTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CancelExportTask operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelImportTaskRequestMarshaller"> <summary> CancelImportTask Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelImportTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CancelImportTask operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelledSpotInstanceRequestUnmarshaller"> <summary> Response Unmarshaller for CancelledSpotInstanceRequest Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelReservedInstancesListingRequestMarshaller"> <summary> CancelReservedInstancesListing Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelReservedInstancesListingResponseUnmarshaller"> <summary> Response Unmarshaller for CancelReservedInstancesListing operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotFleetRequestsErrorItemUnmarshaller"> <summary> Response Unmarshaller for CancelSpotFleetRequestsErrorItem Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotFleetRequestsErrorUnmarshaller"> <summary> Response Unmarshaller for CancelSpotFleetRequestsError Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotFleetRequestsRequestMarshaller"> <summary> CancelSpotFleetRequests Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotFleetRequestsResponseUnmarshaller"> <summary> Response Unmarshaller for CancelSpotFleetRequests operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotFleetRequestsSuccessItemUnmarshaller"> <summary> Response Unmarshaller for CancelSpotFleetRequestsSuccessItem Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotInstanceRequestsRequestMarshaller"> <summary> CancelSpotInstanceRequests Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CancelSpotInstanceRequestsResponseUnmarshaller"> <summary> Response Unmarshaller for CancelSpotInstanceRequests operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ClassicLinkInstanceUnmarshaller"> <summary> Response Unmarshaller for ClassicLinkInstance Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ConfirmProductInstanceRequestMarshaller"> <summary> ConfirmProductInstance Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ConfirmProductInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for ConfirmProductInstance operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ConversionTaskUnmarshaller"> <summary> Response Unmarshaller for ConversionTask Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CopyImageRequestMarshaller"> <summary> CopyImage Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CopyImageResponseUnmarshaller"> <summary> Response Unmarshaller for CopyImage operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CopySnapshotRequestMarshaller"> <summary> CopySnapshot Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CopySnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for CopySnapshot operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateCustomerGatewayRequestMarshaller"> <summary> CreateCustomerGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateCustomerGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for CreateCustomerGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateDhcpOptionsRequestMarshaller"> <summary> CreateDhcpOptions Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateDhcpOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for CreateDhcpOptions operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateFlowLogsRequestMarshaller"> <summary> CreateFlowLogs Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateFlowLogsResponseUnmarshaller"> <summary> Response Unmarshaller for CreateFlowLogs operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateImageRequestMarshaller"> <summary> CreateImage Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateImageResponseUnmarshaller"> <summary> Response Unmarshaller for CreateImage operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateInstanceExportTaskRequestMarshaller"> <summary> CreateInstanceExportTask Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateInstanceExportTaskResponseUnmarshaller"> <summary> Response Unmarshaller for CreateInstanceExportTask operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateInternetGatewayRequestMarshaller"> <summary> CreateInternetGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateInternetGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for CreateInternetGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateKeyPairRequestMarshaller"> <summary> CreateKeyPair Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateKeyPairResponseUnmarshaller"> <summary> Response Unmarshaller for CreateKeyPair operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkAclEntryRequestMarshaller"> <summary> CreateNetworkAclEntry Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkAclEntryResponseUnmarshaller"> <summary> Response Unmarshaller for CreateNetworkAclEntry operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkAclRequestMarshaller"> <summary> CreateNetworkAcl Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkAclResponseUnmarshaller"> <summary> Response Unmarshaller for CreateNetworkAcl operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkInterfaceRequestMarshaller"> <summary> CreateNetworkInterface Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateNetworkInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for CreateNetworkInterface operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreatePlacementGroupRequestMarshaller"> <summary> CreatePlacementGroup Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreatePlacementGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreatePlacementGroup operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateReservedInstancesListingRequestMarshaller"> <summary> CreateReservedInstancesListing Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateReservedInstancesListingResponseUnmarshaller"> <summary> Response Unmarshaller for CreateReservedInstancesListing operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateRouteRequestMarshaller"> <summary> CreateRoute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateRouteResponseUnmarshaller"> <summary> Response Unmarshaller for CreateRoute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateRouteTableRequestMarshaller"> <summary> CreateRouteTable Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateRouteTableResponseUnmarshaller"> <summary> Response Unmarshaller for CreateRouteTable operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSecurityGroupRequestMarshaller"> <summary> CreateSecurityGroup Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSecurityGroupResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSecurityGroup operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSnapshotRequestMarshaller"> <summary> CreateSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSnapshot operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSpotDatafeedSubscriptionRequestMarshaller"> <summary> CreateSpotDatafeedSubscription Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSpotDatafeedSubscriptionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSpotDatafeedSubscription operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSubnetRequestMarshaller"> <summary> CreateSubnet Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateSubnetResponseUnmarshaller"> <summary> Response Unmarshaller for CreateSubnet operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateTagsRequestMarshaller"> <summary> CreateTags Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateTagsResponseUnmarshaller"> <summary> Response Unmarshaller for CreateTags operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVolumePermissionUnmarshaller"> <summary> Response Unmarshaller for CreateVolumePermission Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVolumeRequestMarshaller"> <summary> CreateVolume Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVolumeResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVolume operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcEndpointRequestMarshaller"> <summary> CreateVpcEndpoint Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcEndpointResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpcEndpoint operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcPeeringConnectionRequestMarshaller"> <summary> CreateVpcPeeringConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcPeeringConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpcPeeringConnection operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcRequestMarshaller"> <summary> CreateVpc Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpcResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpc operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnConnectionRequestMarshaller"> <summary> CreateVpnConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpnConnection operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnConnectionRouteRequestMarshaller"> <summary> CreateVpnConnectionRoute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnConnectionRouteResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpnConnectionRoute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnGatewayRequestMarshaller"> <summary> CreateVpnGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CreateVpnGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for CreateVpnGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.CustomerGatewayUnmarshaller"> <summary> Response Unmarshaller for CustomerGateway Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteCustomerGatewayRequestMarshaller"> <summary> DeleteCustomerGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteCustomerGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteCustomerGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteDhcpOptionsRequestMarshaller"> <summary> DeleteDhcpOptions Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteDhcpOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteDhcpOptions operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteFlowLogsRequestMarshaller"> <summary> DeleteFlowLogs Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteFlowLogsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteFlowLogs operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteInternetGatewayRequestMarshaller"> <summary> DeleteInternetGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteInternetGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteInternetGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteKeyPairRequestMarshaller"> <summary> DeleteKeyPair Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteKeyPairResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteKeyPair operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkAclEntryRequestMarshaller"> <summary> DeleteNetworkAclEntry Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkAclEntryResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteNetworkAclEntry operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkAclRequestMarshaller"> <summary> DeleteNetworkAcl Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkAclResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteNetworkAcl operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkInterfaceRequestMarshaller"> <summary> DeleteNetworkInterface Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteNetworkInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteNetworkInterface operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeletePlacementGroupRequestMarshaller"> <summary> DeletePlacementGroup Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeletePlacementGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeletePlacementGroup operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteRouteRequestMarshaller"> <summary> DeleteRoute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteRouteResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRoute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteRouteTableRequestMarshaller"> <summary> DeleteRouteTable Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteRouteTableResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteRouteTable operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSecurityGroupRequestMarshaller"> <summary> DeleteSecurityGroup Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSecurityGroupResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSecurityGroup operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSnapshotRequestMarshaller"> <summary> DeleteSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSnapshot operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSpotDatafeedSubscriptionRequestMarshaller"> <summary> DeleteSpotDatafeedSubscription Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSpotDatafeedSubscriptionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSpotDatafeedSubscription operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSubnetRequestMarshaller"> <summary> DeleteSubnet Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteSubnetResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteSubnet operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteTagsRequestMarshaller"> <summary> DeleteTags Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteTagsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteTags operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVolumeRequestMarshaller"> <summary> DeleteVolume Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVolumeResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVolume operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcEndpointsRequestMarshaller"> <summary> DeleteVpcEndpoints Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcEndpointsResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpcEndpoints operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcPeeringConnectionRequestMarshaller"> <summary> DeleteVpcPeeringConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcPeeringConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpcPeeringConnection operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcRequestMarshaller"> <summary> DeleteVpc Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpcResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpc operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnConnectionRequestMarshaller"> <summary> DeleteVpnConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpnConnection operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnConnectionRouteRequestMarshaller"> <summary> DeleteVpnConnectionRoute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnConnectionRouteResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpnConnectionRoute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnGatewayRequestMarshaller"> <summary> DeleteVpnGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeleteVpnGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for DeleteVpnGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeregisterImageRequestMarshaller"> <summary> DeregisterImage Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DeregisterImageResponseUnmarshaller"> <summary> Response Unmarshaller for DeregisterImage operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAccountAttributesRequestMarshaller"> <summary> DescribeAccountAttributes Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAccountAttributesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAccountAttributes operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAddressesRequestMarshaller"> <summary> DescribeAddresses Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAddressesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAddresses operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAvailabilityZonesRequestMarshaller"> <summary> DescribeAvailabilityZones Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeAvailabilityZonesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeAvailabilityZones operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeBundleTasksRequestMarshaller"> <summary> DescribeBundleTasks Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeBundleTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeBundleTasks operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeClassicLinkInstancesRequestMarshaller"> <summary> DescribeClassicLinkInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeClassicLinkInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeClassicLinkInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeConversionTasksRequestMarshaller"> <summary> DescribeConversionTasks Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeConversionTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeConversionTasks operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeCustomerGatewaysRequestMarshaller"> <summary> DescribeCustomerGateways Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeCustomerGatewaysResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeCustomerGateways operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeDhcpOptionsRequestMarshaller"> <summary> DescribeDhcpOptions Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeDhcpOptionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeDhcpOptions operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeExportTasksRequestMarshaller"> <summary> DescribeExportTasks Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeExportTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeExportTasks operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeFlowLogsRequestMarshaller"> <summary> DescribeFlowLogs Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeFlowLogsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeFlowLogs operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImageAttributeRequestMarshaller"> <summary> DescribeImageAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImageAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeImageAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImagesRequestMarshaller"> <summary> DescribeImages Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImagesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeImages operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImportImageTasksRequestMarshaller"> <summary> DescribeImportImageTasks Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImportImageTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeImportImageTasks operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImportSnapshotTasksRequestMarshaller"> <summary> DescribeImportSnapshotTasks Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeImportSnapshotTasksResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeImportSnapshotTasks operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstanceAttributeRequestMarshaller"> <summary> DescribeInstanceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstanceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInstanceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstancesRequestMarshaller"> <summary> DescribeInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstanceStatusRequestMarshaller"> <summary> DescribeInstanceStatus Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInstanceStatusResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInstanceStatus operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInternetGatewaysRequestMarshaller"> <summary> DescribeInternetGateways Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeInternetGatewaysResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeInternetGateways operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeKeyPairsRequestMarshaller"> <summary> DescribeKeyPairs Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeKeyPairsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeKeyPairs operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeMovingAddressesRequestMarshaller"> <summary> DescribeMovingAddresses Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeMovingAddressesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeMovingAddresses operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkAclsRequestMarshaller"> <summary> DescribeNetworkAcls Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkAclsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeNetworkAcls operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkInterfaceAttributeRequestMarshaller"> <summary> DescribeNetworkInterfaceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkInterfaceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeNetworkInterfaceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkInterfacesRequestMarshaller"> <summary> DescribeNetworkInterfaces Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeNetworkInterfacesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeNetworkInterfaces operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribePlacementGroupsRequestMarshaller"> <summary> DescribePlacementGroups Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribePlacementGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribePlacementGroups operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribePrefixListsRequestMarshaller"> <summary> DescribePrefixLists Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribePrefixListsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribePrefixLists operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeRegionsRequestMarshaller"> <summary> DescribeRegions Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeRegionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeRegions operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesListingsRequestMarshaller"> <summary> DescribeReservedInstancesListings Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesListingsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedInstancesListings operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesModificationsRequestMarshaller"> <summary> DescribeReservedInstancesModifications Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesModificationsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedInstancesModifications operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesOfferingsRequestMarshaller"> <summary> DescribeReservedInstancesOfferings Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesOfferingsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedInstancesOfferings operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesRequestMarshaller"> <summary> DescribeReservedInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeReservedInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeReservedInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeRouteTablesRequestMarshaller"> <summary> DescribeRouteTables Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeRouteTablesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeRouteTables operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSecurityGroupsRequestMarshaller"> <summary> DescribeSecurityGroups Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSecurityGroupsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSecurityGroups operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSnapshotAttributeRequestMarshaller"> <summary> DescribeSnapshotAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSnapshotAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSnapshotAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSnapshotsRequestMarshaller"> <summary> DescribeSnapshots Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSnapshotsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSnapshots operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotDatafeedSubscriptionRequestMarshaller"> <summary> DescribeSpotDatafeedSubscription Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotDatafeedSubscriptionResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotDatafeedSubscription operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetInstancesRequestMarshaller"> <summary> DescribeSpotFleetInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotFleetInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetRequestHistoryRequestMarshaller"> <summary> DescribeSpotFleetRequestHistory Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetRequestHistoryResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotFleetRequestHistory operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetRequestsRequestMarshaller"> <summary> DescribeSpotFleetRequests Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotFleetRequestsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotFleetRequests operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotInstanceRequestsRequestMarshaller"> <summary> DescribeSpotInstanceRequests Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotInstanceRequestsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotInstanceRequests operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotPriceHistoryRequestMarshaller"> <summary> DescribeSpotPriceHistory Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSpotPriceHistoryResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSpotPriceHistory operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSubnetsRequestMarshaller"> <summary> DescribeSubnets Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeSubnetsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeSubnets operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeTagsRequestMarshaller"> <summary> DescribeTags Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeTagsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeTags operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumeAttributeRequestMarshaller"> <summary> DescribeVolumeAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumeAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVolumeAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumesRequestMarshaller"> <summary> DescribeVolumes Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVolumes operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumeStatusRequestMarshaller"> <summary> DescribeVolumeStatus Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVolumeStatusResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVolumeStatus operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcAttributeRequestMarshaller"> <summary> DescribeVpcAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcClassicLinkRequestMarshaller"> <summary> DescribeVpcClassicLink Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcClassicLinkResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcClassicLink operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcEndpointServicesRequestMarshaller"> <summary> DescribeVpcEndpointServices Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcEndpointServicesResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcEndpointServices operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcEndpointsRequestMarshaller"> <summary> DescribeVpcEndpoints Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcEndpointsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcEndpoints operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcPeeringConnectionsRequestMarshaller"> <summary> DescribeVpcPeeringConnections Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcPeeringConnectionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcPeeringConnections operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcsRequestMarshaller"> <summary> DescribeVpcs Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpcsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpcs operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpnConnectionsRequestMarshaller"> <summary> DescribeVpnConnections Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpnConnectionsResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpnConnections operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpnGatewaysRequestMarshaller"> <summary> DescribeVpnGateways Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DescribeVpnGatewaysResponseUnmarshaller"> <summary> Response Unmarshaller for DescribeVpnGateways operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachClassicLinkVpcRequestMarshaller"> <summary> DetachClassicLinkVpc Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachClassicLinkVpcResponseUnmarshaller"> <summary> Response Unmarshaller for DetachClassicLinkVpc operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachInternetGatewayRequestMarshaller"> <summary> DetachInternetGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachInternetGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for DetachInternetGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachNetworkInterfaceRequestMarshaller"> <summary> DetachNetworkInterface Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachNetworkInterfaceResponseUnmarshaller"> <summary> Response Unmarshaller for DetachNetworkInterface operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachVolumeRequestMarshaller"> <summary> DetachVolume Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachVolumeResponseUnmarshaller"> <summary> Response Unmarshaller for DetachVolume operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachVpnGatewayRequestMarshaller"> <summary> DetachVpnGateway Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DetachVpnGatewayResponseUnmarshaller"> <summary> Response Unmarshaller for DetachVpnGateway operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DhcpConfigurationUnmarshaller"> <summary> Response Unmarshaller for DhcpConfiguration Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DhcpOptionsUnmarshaller"> <summary> Response Unmarshaller for DhcpOptions Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisableVgwRoutePropagationRequestMarshaller"> <summary> DisableVgwRoutePropagation Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisableVgwRoutePropagationResponseUnmarshaller"> <summary> Response Unmarshaller for DisableVgwRoutePropagation operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisableVpcClassicLinkRequestMarshaller"> <summary> DisableVpcClassicLink Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisableVpcClassicLinkResponseUnmarshaller"> <summary> Response Unmarshaller for DisableVpcClassicLink operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisassociateAddressRequestMarshaller"> <summary> DisassociateAddress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisassociateAddressResponseUnmarshaller"> <summary> Response Unmarshaller for DisassociateAddress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisassociateRouteTableRequestMarshaller"> <summary> DisassociateRouteTable Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DisassociateRouteTableResponseUnmarshaller"> <summary> Response Unmarshaller for DisassociateRouteTable operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DiskImageDescriptionUnmarshaller"> <summary> Response Unmarshaller for DiskImageDescription Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.DiskImageVolumeDescriptionUnmarshaller"> <summary> Response Unmarshaller for DiskImageVolumeDescription Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EbsBlockDeviceUnmarshaller"> <summary> Response Unmarshaller for EbsBlockDevice Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EbsInstanceBlockDeviceUnmarshaller"> <summary> Response Unmarshaller for EbsInstanceBlockDevice Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVgwRoutePropagationRequestMarshaller"> <summary> EnableVgwRoutePropagation Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVgwRoutePropagationResponseUnmarshaller"> <summary> Response Unmarshaller for EnableVgwRoutePropagation operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVolumeIORequestMarshaller"> <summary> EnableVolumeIO Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVolumeIOResponseUnmarshaller"> <summary> Response Unmarshaller for EnableVolumeIO operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVpcClassicLinkRequestMarshaller"> <summary> EnableVpcClassicLink Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EnableVpcClassicLinkResponseUnmarshaller"> <summary> Response Unmarshaller for EnableVpcClassicLink operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.EventInformationUnmarshaller"> <summary> Response Unmarshaller for EventInformation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ExportTaskUnmarshaller"> <summary> Response Unmarshaller for ExportTask Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ExportToS3TaskUnmarshaller"> <summary> Response Unmarshaller for ExportToS3Task Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.FlowLogUnmarshaller"> <summary> Response Unmarshaller for FlowLog Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.GetConsoleOutputRequestMarshaller"> <summary> GetConsoleOutput Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.GetConsoleOutputResponseUnmarshaller"> <summary> Response Unmarshaller for GetConsoleOutput operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.GetPasswordDataRequestMarshaller"> <summary> GetPasswordData Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.GetPasswordDataResponseUnmarshaller"> <summary> Response Unmarshaller for GetPasswordData operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.GroupIdentifierUnmarshaller"> <summary> Response Unmarshaller for GroupIdentifier Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.HistoryRecordUnmarshaller"> <summary> Response Unmarshaller for HistoryRecord Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.IamInstanceProfileSpecificationUnmarshaller"> <summary> Response Unmarshaller for IamInstanceProfileSpecification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.IamInstanceProfileUnmarshaller"> <summary> Response Unmarshaller for IamInstanceProfile Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.IcmpTypeCodeUnmarshaller"> <summary> Response Unmarshaller for IcmpTypeCode Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImageAttributeUnmarshaller"> <summary> Response Unmarshaller for ImageAttribute Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImageUnmarshaller"> <summary> Response Unmarshaller for Image Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportImageRequestMarshaller"> <summary> ImportImage Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportImageResponseUnmarshaller"> <summary> Response Unmarshaller for ImportImage operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportImageTaskUnmarshaller"> <summary> Response Unmarshaller for ImportImageTask Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportInstanceRequestMarshaller"> <summary> ImportInstance Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportInstanceResponseUnmarshaller"> <summary> Response Unmarshaller for ImportInstance operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportInstanceTaskDetailsUnmarshaller"> <summary> Response Unmarshaller for ImportInstanceTaskDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportInstanceVolumeDetailItemUnmarshaller"> <summary> Response Unmarshaller for ImportInstanceVolumeDetailItem Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportKeyPairRequestMarshaller"> <summary> ImportKeyPair Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportKeyPairResponseUnmarshaller"> <summary> Response Unmarshaller for ImportKeyPair operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportSnapshotRequestMarshaller"> <summary> ImportSnapshot Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportSnapshotResponseUnmarshaller"> <summary> Response Unmarshaller for ImportSnapshot operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportSnapshotTaskUnmarshaller"> <summary> Response Unmarshaller for ImportSnapshotTask Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportVolumeRequestMarshaller"> <summary> ImportVolume Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportVolumeResponseUnmarshaller"> <summary> Response Unmarshaller for ImportVolume operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ImportVolumeTaskDetailsUnmarshaller"> <summary> Response Unmarshaller for ImportVolumeTaskDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceAttributeUnmarshaller"> <summary> Response Unmarshaller for InstanceAttribute Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceBlockDeviceMappingUnmarshaller"> <summary> Response Unmarshaller for InstanceBlockDeviceMapping Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceCountUnmarshaller"> <summary> Response Unmarshaller for InstanceCount Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceExportDetailsUnmarshaller"> <summary> Response Unmarshaller for InstanceExportDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceMonitoringUnmarshaller"> <summary> Response Unmarshaller for InstanceMonitoring Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceNetworkInterfaceAssociationUnmarshaller"> <summary> Response Unmarshaller for InstanceNetworkInterfaceAssociation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceNetworkInterfaceAttachmentUnmarshaller"> <summary> Response Unmarshaller for InstanceNetworkInterfaceAttachment Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceNetworkInterfaceSpecificationUnmarshaller"> <summary> Response Unmarshaller for InstanceNetworkInterfaceSpecification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceNetworkInterfaceUnmarshaller"> <summary> Response Unmarshaller for InstanceNetworkInterface Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstancePrivateIpAddressUnmarshaller"> <summary> Response Unmarshaller for InstancePrivateIpAddress Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStateChangeUnmarshaller"> <summary> Response Unmarshaller for InstanceStateChange Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStateUnmarshaller"> <summary> Response Unmarshaller for InstanceState Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStatusDetailsUnmarshaller"> <summary> Response Unmarshaller for InstanceStatusDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStatusEventUnmarshaller"> <summary> Response Unmarshaller for InstanceStatusEvent Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStatusSummaryUnmarshaller"> <summary> Response Unmarshaller for InstanceStatusSummary Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceStatusUnmarshaller"> <summary> Response Unmarshaller for InstanceStatus Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InstanceUnmarshaller"> <summary> Response Unmarshaller for Instance Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InternetGatewayAttachmentUnmarshaller"> <summary> Response Unmarshaller for InternetGatewayAttachment Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.InternetGatewayUnmarshaller"> <summary> Response Unmarshaller for InternetGateway Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.IpPermissionUnmarshaller"> <summary> Response Unmarshaller for IpPermission Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.KeyPairInfoUnmarshaller"> <summary> Response Unmarshaller for KeyPairInfo Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.KeyPairUnmarshaller"> <summary> Response Unmarshaller for KeyPair Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.LaunchPermissionUnmarshaller"> <summary> Response Unmarshaller for LaunchPermission Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.LaunchSpecificationUnmarshaller"> <summary> Response Unmarshaller for LaunchSpecification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyImageAttributeRequestMarshaller"> <summary> ModifyImageAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyImageAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyImageAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyInstanceAttributeRequestMarshaller"> <summary> ModifyInstanceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyInstanceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyInstanceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyNetworkInterfaceAttributeRequestMarshaller"> <summary> ModifyNetworkInterfaceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyNetworkInterfaceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyNetworkInterfaceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyReservedInstancesRequestMarshaller"> <summary> ModifyReservedInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyReservedInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyReservedInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifySnapshotAttributeRequestMarshaller"> <summary> ModifySnapshotAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifySnapshotAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifySnapshotAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifySubnetAttributeRequestMarshaller"> <summary> ModifySubnetAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifySubnetAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifySubnetAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVolumeAttributeRequestMarshaller"> <summary> ModifyVolumeAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVolumeAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyVolumeAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVpcAttributeRequestMarshaller"> <summary> ModifyVpcAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVpcAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyVpcAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVpcEndpointRequestMarshaller"> <summary> ModifyVpcEndpoint Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ModifyVpcEndpointResponseUnmarshaller"> <summary> Response Unmarshaller for ModifyVpcEndpoint operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MonitoringUnmarshaller"> <summary> Response Unmarshaller for Monitoring Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MonitorInstancesRequestMarshaller"> <summary> MonitorInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MonitorInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for MonitorInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MoveAddressToVpcRequestMarshaller"> <summary> MoveAddressToVpc Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MoveAddressToVpcResponseUnmarshaller"> <summary> Response Unmarshaller for MoveAddressToVpc operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.MovingAddressStatusUnmarshaller"> <summary> Response Unmarshaller for MovingAddressStatus Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkAclAssociationUnmarshaller"> <summary> Response Unmarshaller for NetworkAclAssociation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkAclEntryUnmarshaller"> <summary> Response Unmarshaller for NetworkAclEntry Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkAclUnmarshaller"> <summary> Response Unmarshaller for NetworkAcl Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkInterfaceAssociationUnmarshaller"> <summary> Response Unmarshaller for NetworkInterfaceAssociation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkInterfaceAttachmentUnmarshaller"> <summary> Response Unmarshaller for NetworkInterfaceAttachment Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkInterfacePrivateIpAddressUnmarshaller"> <summary> Response Unmarshaller for NetworkInterfacePrivateIpAddress Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.NetworkInterfaceUnmarshaller"> <summary> Response Unmarshaller for NetworkInterface Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PlacementGroupUnmarshaller"> <summary> Response Unmarshaller for PlacementGroup Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PlacementUnmarshaller"> <summary> Response Unmarshaller for Placement Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PortRangeUnmarshaller"> <summary> Response Unmarshaller for PortRange Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PrefixListIdUnmarshaller"> <summary> Response Unmarshaller for PrefixListId Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PrefixListUnmarshaller"> <summary> Response Unmarshaller for PrefixList Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PriceScheduleUnmarshaller"> <summary> Response Unmarshaller for PriceSchedule Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PricingDetailUnmarshaller"> <summary> Response Unmarshaller for PricingDetail Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PrivateIpAddressSpecificationUnmarshaller"> <summary> Response Unmarshaller for PrivateIpAddressSpecification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ProductCodeUnmarshaller"> <summary> Response Unmarshaller for ProductCode Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PropagatingVgwUnmarshaller"> <summary> Response Unmarshaller for PropagatingVgw Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PurchaseReservedInstancesOfferingRequestMarshaller"> <summary> PurchaseReservedInstancesOffering Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.PurchaseReservedInstancesOfferingResponseUnmarshaller"> <summary> Response Unmarshaller for PurchaseReservedInstancesOffering operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RebootInstancesRequestMarshaller"> <summary> RebootInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RebootInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for RebootInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RecurringChargeUnmarshaller"> <summary> Response Unmarshaller for RecurringCharge Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RegionUnmarshaller"> <summary> Response Unmarshaller for Region Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RegisterImageRequestMarshaller"> <summary> RegisterImage Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RegisterImageResponseUnmarshaller"> <summary> Response Unmarshaller for RegisterImage operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RejectVpcPeeringConnectionRequestMarshaller"> <summary> RejectVpcPeeringConnection Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RejectVpcPeeringConnectionResponseUnmarshaller"> <summary> Response Unmarshaller for RejectVpcPeeringConnection operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReleaseAddressRequestMarshaller"> <summary> ReleaseAddress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReleaseAddressResponseUnmarshaller"> <summary> Response Unmarshaller for ReleaseAddress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceNetworkAclAssociationRequestMarshaller"> <summary> ReplaceNetworkAclAssociation Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceNetworkAclAssociationResponseUnmarshaller"> <summary> Response Unmarshaller for ReplaceNetworkAclAssociation operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceNetworkAclEntryRequestMarshaller"> <summary> ReplaceNetworkAclEntry Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceNetworkAclEntryResponseUnmarshaller"> <summary> Response Unmarshaller for ReplaceNetworkAclEntry operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceRouteRequestMarshaller"> <summary> ReplaceRoute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceRouteResponseUnmarshaller"> <summary> Response Unmarshaller for ReplaceRoute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceRouteTableAssociationRequestMarshaller"> <summary> ReplaceRouteTableAssociation Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReplaceRouteTableAssociationResponseUnmarshaller"> <summary> Response Unmarshaller for ReplaceRouteTableAssociation operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReportInstanceStatusRequestMarshaller"> <summary> ReportInstanceStatus Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReportInstanceStatusResponseUnmarshaller"> <summary> Response Unmarshaller for ReportInstanceStatus operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RequestSpotFleetRequestMarshaller"> <summary> RequestSpotFleet Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RequestSpotFleetResponseUnmarshaller"> <summary> Response Unmarshaller for RequestSpotFleet operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RequestSpotInstancesRequestMarshaller"> <summary> RequestSpotInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RequestSpotInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for RequestSpotInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservationUnmarshaller"> <summary> Response Unmarshaller for Reservation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesConfigurationUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesConfiguration Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesIdUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesId Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesListingUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesListing Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesModificationResultUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesModificationResult Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesModificationUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesModification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesOfferingUnmarshaller"> <summary> Response Unmarshaller for ReservedInstancesOffering Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ReservedInstancesUnmarshaller"> <summary> Response Unmarshaller for ReservedInstances Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetImageAttributeRequestMarshaller"> <summary> ResetImageAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetImageAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ResetImageAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetInstanceAttributeRequestMarshaller"> <summary> ResetInstanceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetInstanceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ResetInstanceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetNetworkInterfaceAttributeRequestMarshaller"> <summary> ResetNetworkInterfaceAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetNetworkInterfaceAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ResetNetworkInterfaceAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetSnapshotAttributeRequestMarshaller"> <summary> ResetSnapshotAttribute Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.ResetSnapshotAttributeResponseUnmarshaller"> <summary> Response Unmarshaller for ResetSnapshotAttribute operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RestoreAddressToClassicRequestMarshaller"> <summary> RestoreAddressToClassic Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RestoreAddressToClassicResponseUnmarshaller"> <summary> Response Unmarshaller for RestoreAddressToClassic operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RevokeSecurityGroupEgressRequestMarshaller"> <summary> RevokeSecurityGroupEgress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RevokeSecurityGroupEgressResponseUnmarshaller"> <summary> Response Unmarshaller for RevokeSecurityGroupEgress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RevokeSecurityGroupIngressRequestMarshaller"> <summary> RevokeSecurityGroupIngress Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RevokeSecurityGroupIngressResponseUnmarshaller"> <summary> Response Unmarshaller for RevokeSecurityGroupIngress operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RouteTableAssociationUnmarshaller"> <summary> Response Unmarshaller for RouteTableAssociation Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RouteTableUnmarshaller"> <summary> Response Unmarshaller for RouteTable Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RouteUnmarshaller"> <summary> Response Unmarshaller for Route Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RunInstancesRequestMarshaller"> <summary> RunInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.RunInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for RunInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.S3StorageUnmarshaller"> <summary> Response Unmarshaller for S3Storage Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SecurityGroupUnmarshaller"> <summary> Response Unmarshaller for SecurityGroup Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SnapshotDetailUnmarshaller"> <summary> Response Unmarshaller for SnapshotDetail Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SnapshotTaskDetailUnmarshaller"> <summary> Response Unmarshaller for SnapshotTaskDetail Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SnapshotUnmarshaller"> <summary> Response Unmarshaller for Snapshot Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotDatafeedSubscriptionUnmarshaller"> <summary> Response Unmarshaller for SpotDatafeedSubscription Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotFleetLaunchSpecificationUnmarshaller"> <summary> Response Unmarshaller for SpotFleetLaunchSpecification Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotFleetMonitoringUnmarshaller"> <summary> Response Unmarshaller for SpotFleetMonitoring Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotFleetRequestConfigDataUnmarshaller"> <summary> Response Unmarshaller for SpotFleetRequestConfigData Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotFleetRequestConfigUnmarshaller"> <summary> Response Unmarshaller for SpotFleetRequestConfig Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotInstanceRequestUnmarshaller"> <summary> Response Unmarshaller for SpotInstanceRequest Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotInstanceStateFaultUnmarshaller"> <summary> Response Unmarshaller for SpotInstanceStateFault Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotInstanceStatusUnmarshaller"> <summary> Response Unmarshaller for SpotInstanceStatus Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotPlacementUnmarshaller"> <summary> Response Unmarshaller for SpotPlacement Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SpotPriceUnmarshaller"> <summary> Response Unmarshaller for SpotPrice Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StartInstancesRequestMarshaller"> <summary> StartInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StartInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for StartInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StateReasonUnmarshaller"> <summary> Response Unmarshaller for StateReason Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StopInstancesRequestMarshaller"> <summary> StopInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StopInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for StopInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.StorageUnmarshaller"> <summary> Response Unmarshaller for Storage Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.SubnetUnmarshaller"> <summary> Response Unmarshaller for Subnet Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.TagDescriptionUnmarshaller"> <summary> Response Unmarshaller for TagDescription Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.TagUnmarshaller"> <summary> Response Unmarshaller for Tag Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.TerminateInstancesRequestMarshaller"> <summary> TerminateInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.TerminateInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for TerminateInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnassignPrivateIpAddressesRequestMarshaller"> <summary> UnassignPrivateIpAddresses Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnassignPrivateIpAddressesResponseUnmarshaller"> <summary> Response Unmarshaller for UnassignPrivateIpAddresses operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnmonitorInstancesRequestMarshaller"> <summary> UnmonitorInstances Request Marshaller </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnmonitorInstancesResponseUnmarshaller"> <summary> Response Unmarshaller for UnmonitorInstances operation </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnsuccessfulItemErrorUnmarshaller"> <summary> Response Unmarshaller for UnsuccessfulItemError Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UnsuccessfulItemUnmarshaller"> <summary> Response Unmarshaller for UnsuccessfulItem Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UserBucketDetailsUnmarshaller"> <summary> Response Unmarshaller for UserBucketDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.UserIdGroupPairUnmarshaller"> <summary> Response Unmarshaller for UserIdGroupPair Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VgwTelemetryUnmarshaller"> <summary> Response Unmarshaller for VgwTelemetry Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeAttachmentUnmarshaller"> <summary> Response Unmarshaller for VolumeAttachment Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeStatusActionUnmarshaller"> <summary> Response Unmarshaller for VolumeStatusAction Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeStatusDetailsUnmarshaller"> <summary> Response Unmarshaller for VolumeStatusDetails Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeStatusEventUnmarshaller"> <summary> Response Unmarshaller for VolumeStatusEvent Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeStatusInfoUnmarshaller"> <summary> Response Unmarshaller for VolumeStatusInfo Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeStatusItemUnmarshaller"> <summary> Response Unmarshaller for VolumeStatusItem Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VolumeUnmarshaller"> <summary> Response Unmarshaller for Volume Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcAttachmentUnmarshaller"> <summary> Response Unmarshaller for VpcAttachment Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcClassicLinkUnmarshaller"> <summary> Response Unmarshaller for VpcClassicLink Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcEndpointUnmarshaller"> <summary> Response Unmarshaller for VpcEndpoint Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcPeeringConnectionStateReasonUnmarshaller"> <summary> Response Unmarshaller for VpcPeeringConnectionStateReason Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcPeeringConnectionUnmarshaller"> <summary> Response Unmarshaller for VpcPeeringConnection Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcPeeringConnectionVpcInfoUnmarshaller"> <summary> Response Unmarshaller for VpcPeeringConnectionVpcInfo Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpcUnmarshaller"> <summary> Response Unmarshaller for Vpc Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpnConnectionOptionsUnmarshaller"> <summary> Response Unmarshaller for VpnConnectionOptions Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpnConnectionUnmarshaller"> <summary> Response Unmarshaller for VpnConnection Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpnGatewayUnmarshaller"> <summary> Response Unmarshaller for VpnGateway Object </summary> </member> <member name="T:Amazon.EC2.Model.Internal.MarshallTransformations.VpnStaticRouteUnmarshaller"> <summary> Response Unmarshaller for VpnStaticRoute Object </summary> </member> <member name="T:Amazon.EC2.Import.ImportProgressCallback"> <summary> Callback signature to report progress on the manifest creation and upload process. </summary> <param name="message">Describes the current in-progress task</param> <param name="percentComplete">If not null, the percentage completion of the image file upload</param> </member> <member name="T:Amazon.EC2.Import.DiskImageImporter"> <summary> Helper class to import a virtual machine image or disk image to Amazon EC2 using Amazon S3 to hold the in-flight artifacts. </summary> </member> <member name="F:Amazon.EC2.Import.DiskImageImporter.DefaultUploadThreads"> <summary> The default number of threads that will be used to upload the parts comprising the image file. Each thread will consume a 10MB buffer to process the part data. </summary> </member> <member name="F:Amazon.EC2.Import.DiskImageImporter.DefaultUrlExpirationInDays"> <summary> The default validity period for the signed Amazon S3 URLs that allow Amazon EC2 to access the manifest. </summary> </member> <member name="F:Amazon.EC2.Import.DiskImageImporter.MaxUploadThreads"> <summary> The maximum number of threads that can be used to upload the image file parts. </summary> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.#ctor(Amazon.RegionEndpoint,System.String)"> <summary> Constructs an image importer to upload and convert virtual machine image or disk volumes for use with Amazon EC2. AWS credentials will be obtained from the application configuration settings. </summary> <param name="region"> The region to which the artifacts will be uploaded and EC2 conversion performed. </param> <param name="bucketName"> The name of the Amazon S3 bucket that will contain the uploaded image and manifest. If the bucket does not exist it will be created. </param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.#ctor(Amazon.S3.IAmazonS3,Amazon.EC2.IAmazonEC2,System.String)"> <summary> Constructs an image importer to upload and convert virtual machine image or disk volumes for use with Amazon EC2. The importer will use the supplied clients for communicating with Amazon S3 and Amazon EC2. Note that the clients should be configured to use the same region and AWS account. </summary> <param name="s3Client">Client to use to upload artifacts to Amazon S3</param> <param name="ec2Client">Client to use to request image conversion in Amazon EC2</param> <param name="bucketName"> The name of the Amazon S3 bucket that will contain the uploaded image and manifest. If the bucket does not exist it will be created. </param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint,System.String)"> <summary> Constructs an image importer to upload and convert virtual machine image or disk volumes for use with Amazon EC2. </summary> <param name="credentials"> The AWS credentials of the account that will own the uploaded artifacts. </param> <param name="region"> The region to which the artifacts will be uploaded and EC2 conversion performed. </param> <param name="bucketName"> The name of the Amazon S3 bucket that will contain the uploaded image and manifest. If the bucket does not exist it will be created. </param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.ImportInstance(System.String,System.String,System.Nullable{System.Int64},System.String,Amazon.EC2.Import.ImportLaunchConfiguration,Amazon.EC2.Import.ImportProgressCallback)"> <summary> Uploads and requests import conversion of a virtual machine image file to an Amazon EC2 instance. </summary> <param name="imageFilepath">The full path to the image file to be processed</param> <param name="fileFormat"> The format of the image file (VMDK | RAW | VHD). If not specified, it will be inferred from the extension of the image file. </param> <param name="volumeSize"> The requested size (in GiB) for the resulting image volume. If not specified a suitable value based on the size of the image file is used. Note that the minimum required boot volume size for EC2 is 8GB. </param> <param name="keyPrefix"> Optional root-level key prefix that will be applied to the uploaded artifacts in S3. The artifacts will be placed beneath this (or the root if not set) in a key composed of a GUID. </param> <param name="launchConfiguration">Launch configuration settings for the imported instance</param> <param name="progressCallback">Optional callback delegate for upload progress reporting</param> <returns> The service response containing a ConversionTask object that can be used to monitor the progress of the requested conversion. </returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.ImportVolume(System.String,System.String,System.Nullable{System.Int64},System.String,System.String,System.String,Amazon.EC2.Import.ImportProgressCallback)"> <summary> Uploads and requests import conversion of a virtual disk file to an Amazon EBS volume. </summary> <param name="imageFilepath">The full path to the image file to be processed</param> <param name="fileFormat"> The format of the image file (VMDK | RAW | VHD). If not specified, it will be inferred from the extension of the image file. </param> <param name="volumeSize"> The requested size (in GiB) for the resulting image volume. If not specified a suitable value based on the size of the image file is used. </param> <param name="keyPrefix"> Optional root-level key prefix that will be applied to the uploaded artifacts in S3. The artifacts will be placed beneath this (or the root if not set) in a key composed of a GUID. </param> <param name="availabilityZone">The Availability Zone for the resulting Amazon EBS volume.</param> <param name="description">An optional description for the volume being imported.</param> <param name="progressCallback">Optional callback delegate for upload progress reporting</param> <returns> The service response containing a ConversionTask object that can be used to monitor the progress of the requested conversion. </returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.Upload(System.String)"> <summary> <para> Constructs the import manifest for the image and then uploads it and the virtual machine image or disk image to Amazon S3. The S3 key to the uploaded manifest file is returned. </para> <para> If an error occurs during upload of the image file the RetainArtifactsOnUploadError property governs whether the partially uploaded content is deleted or retained. If the content is retained, the import can be resumed. By default the RetainArtifactsOnUploadError property is false and the content deleted, avoiding storage charges for potentially orphaned content if the command is not re-run. </para> </summary> <param name="imageFilepath">The full path to the image file to be processed</param> <returns>The S3 object key of the uploaded manifest file</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.Upload(System.String,System.String,System.Nullable{System.Int64},System.String,Amazon.EC2.Import.ImportProgressCallback,System.Boolean)"> <summary> <para> Constructs the import manifest for the image and then uploads it and the virtual machine image or disk image to Amazon S3. The S3 key to the uploaded manifest file is returned. </para> <para> If an error occurs during upload of the image file the RetainArtifactsOnUploadError property governs whether the partially uploaded content is deleted or retained. If the content is retained, the import can be resumed. By default the RetainArtifactsOnUploadError property is false and the content deleted, avoiding storage charges for potentially orphaned content if the command is not re-run. </para> </summary> <param name="imageFilepath">The full path to the image file to be processed</param> <param name="fileFormat"> The format of the image file (VMDK | RAW | VHD). If not specified, it will be inferred from the extension of the image file. </param> <param name="volumeSize"> The requested size (in GiB) for the resulting image volume. If not specified a suitable value based on the size of the image file is used. Note that if importing a disk image that will be used as an EC2 instance, the minimum required boot volume size is 8GB. </param> <param name="keyPrefix"> Optional root-level key prefix that will be applied to the uploaded artifacts in S3. The artifacts will be placed beneath this (or the root if not set) in a key composed of a GUID. </param> <param name="progressCallback">Optional callback delegate for upload progress reporting</param> <param name="resumeUpload"> Set this to true if a previous upload failed part-way through processing and RetainArtifactsOnUploadError was set to true so the partially uploaded content was retained. The existing manifest will be inspected and uploads will resume of the retaining content. </param> <returns>The S3 object key of the uploaded manifest file</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.FromManifest(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint,System.String,System.String,System.Boolean)"> <summary> Constructs an importer instance for a previously uploaded manifest. The manifest is downloaded using a new Amazon S3 client constructed for the specified region and deserialized, ready for use in constructing the appropriate ImportInstance or ImportVolume request to Amazon EC2. </summary> <param name="credentials"> The AWS credentials for the account that owns or has access to the bucket containing the manifest file. </param> <param name="region">The region in which the Amazon S3 client used for download will be constructed.</param> <param name="bucketName">The name of the bucket containing the manifest file.</param> <param name="manifestFileKey">The S3 object key of the manifest file.</param> <param name="resumingUpload"> Set this to true if a previous upload failed part-way through processing and RetainArtifactsOnUploadError was set to true so the partially uploaded content was retained. The existing manifest will be inspected and uploads can then resume to process the retaining content. </param> <returns>Initialized importer instance containing a deserialized manifest</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.StartInstanceConversion(Amazon.EC2.Import.ImportLaunchConfiguration)"> <summary> Initiates a conversion task to yield a new Amazon EC2 instance for a set of image file artifacts uploaded previously to Amazon S3. </summary> <param name="launchConfiguration">Launch configuration settings for the imported instance</param> <returns> The service response containing a ConversionTask object that can be used to monitor the progress of the requested conversion. </returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.StartVolumeConversion(System.String,System.String)"> <summary> Initiates a conversion task to yield a new EBS volume for a set of image file artifacts uploaded previously to Amazon S3. </summary> <param name="availabilityZone">The Availability Zone for the resulting Amazon EBS volume.</param> <param name="description">An optional description for the volume being imported.</param> <returns> The service response containing a ConversionTask object that can be used to monitor the progress of the requested conversion. </returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.PopulateDiskImageDetail(System.String)"> <summary> Helper to populate a DiskImageDetail instance from the SDK that will be used in an ImportVolume API request using data previously recorded in the import manifest. </summary> <param name="manifestFileKey">The Amazon S3 object key of the manifest file.</param> <returns>Populated DiskImageDetail instance.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.PopulateDiskImage(System.String,System.String)"> <summary> Helper to populate a DiskImage instance from the SDK that will be used in an ImportInstance API request using data previously recorded in the import manifest. </summary> <param name="manifestFileKey">The Amazon S3 object key of the manifest file.</param> <param name="description">Optional description for the image.</param> <returns>Populated DiskImage instance.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.PopulateVolumeDetail"> <summary> Helper to populate a VolumeDetail instance from the SDK that will be used in an ImportInstance or ImportVolume API request using data previously recorded in the import manifest. </summary> <returns>Populated VolumeDetail instance.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.PopulateLaunchSpecificationInstance(Amazon.EC2.Import.ImportLaunchConfiguration)"> <summary> Helper to populate an SDK ImportInstanceLaunchSpecification instance that will be used in an ImportInstance API request. </summary> <param name="config">Settings for the new LaunchSpecificationInstance</param> <returns>Populated ImportInstanceLaunchSpecification instance.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.DeserializeManifestFromS3"> <summary> Downloads the manifest from Amazon S3 and deserializes the contents. </summary> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.DetermineRemainingUploads"> <summary> Analyzes the parts list of the manifest to determine which object parts exist in S3. Used when instantiating an importer from an existing manifest of a failed uploaded (RetainArtifactsOnUploadError set true to keep the partially uploaded content allowing uploads to be resumed part-way through). </summary> <remarks> Since the manifest contains a set of presigned urls to each part we can make use of those to determine whether a part has been uploaded or not. </remarks> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.GetPresignedManifestUrl(System.String)"> <summary> Constructs the presigned url to the import manifest in S3. </summary> <param name="manifestFileKey">The S3 object key of the manifest file.</param> <returns>Presigned url to the manifest file object.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.ConstructManifestArtifactKey(System.String)"> <summary> Constructs the S3 object key for the manifest artifact. This will combine the root key, any optional prefix the user has requested be applied and the filename of the artifact, plus a fixed extension. </summary> <param name="imageFilepath">The path to the image file</param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.UploadManifest(Amazon.EC2.Import.ImportProgressCallback)"> <summary> Serialize and upload the constructed import manifest using the supplied S3 client with optional progress callback. </summary> <param name="progressCallback">Optional callback to track upload progress.</param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.UploadImageParts(Amazon.EC2.Import.ImportProgressCallback)"> <summary> Uploads the image file to S3 as a series of distinct 10MB objects, as required by EC2, using the constructed import manifest as a guide. If any part fails to upload, we clean up successfully uploaded parts before returning the error to the caller. </summary> <param name="progressCallback">Optional callback to track upload progress.</param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.RemoveUploadedArtifacts(System.String,System.Collections.Generic.IEnumerable{Amazon.EC2.Import.ImageFilePart})"> <summary> Removes the manifest and iterates through the parts list to see which parts had been completed when failures occur and removes those objects to avoid storage cost to the user (if the user retries the command, a different root key guid will be generated leading to potential orphans). </summary> <param name="manifestFileKey">The object key of the manifest file.</param> <param name="partsList">The set of parts that should have been uploaded</param> <returns>True if all objects were successfully deleted, false if objects remain that the user should manually clean up</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.UploadImageFilePart(System.Object)"> <summary> Threadpool delegate to process image file parts one by one and upload to Amazon S3. If an error occurs, we abandon the part and continue to seek new ones (even though we won't process them, only signal). This allows all threads to exit before we attempt error clean up. </summary> <param name="state">ImagePartUploadState instance to process</param> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.CreateImportManifest(System.String,System.Nullable{System.Int64})"> <summary> Constructs the object hierarchy that will be serialized to a single manifest file describing the import. </summary> <param name="fileFormat"> The file format of the image file. If not specified, it will be inferred from the image file extension. Valid values: VMDK | RAW | VHD. </param> <param name="volumeSize"> The requested size, in GiB, of the resulting volume in EC2. If not specified a suitable value will be used based on the size of the supplied image file. </param> <returns>Import manifest ready for serialization and upload.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.ConstructImportPartsList(System.Nullable{System.Int64},System.DateTime)"> <summary> Walks the byte ranges of the image file to construct the logical parts we'll use to perform the upload </summary> <param name="volumeSize">The requested size of the volume in EC2</param> <param name="urlExpiration">The time at which the presigned urls for the parts should expire.</param> <returns>Manifest subcomponent describing the part structure.</returns> </member> <member name="M:Amazon.EC2.Import.DiskImageImporter.VolumeSizeFor(System.Int64,System.Nullable{System.Int64})"> <summary> Computes the size of the volume to hold the image in EC2, with optional override by the user. Observation of the EC2 CLI shows a preferred minimum size for boot volumes of 8GB. </summary> <param name="diskImageSize">The size of the image we're processing, in bytes</param> <param name="requestedSize">Optional size requested by the user</param> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.UploadThreads"> <summary> <para> The number of threads to use to upload the image file parts to Amazon S3. Each thread will consume a 10MB buffer to process the part data. </para> <para> Default: 10. Max: 30. </para> </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.ImportManifest"> <summary> The constructed manifest describing the import artifacts. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.ImageFilePath"> <summary> The absolute path to the image file being imported. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.ManifestFileKey"> <summary> The Amazon S3 object key to the uploaded manifest file. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.RollbackOnUploadError"> <summary> <para> Controls Amazon S3 clean-up of image file and import manifest artifacts if an error occurs during upload. </para> <para> By default, if an error occurs when uploading the image file to S3 the importer will exit and leave what has been uploaded still present in S3. This enables a 'resume mode' where the importer can be run again to continue upload of the remaining parts based on inspection of the bucket vs the manifest. Note that this does leave the potential for storage costs if the user decides to abandon the import (the PowerShell cmdlets that use this importer emit error messages detailing the resume/cleanup instructions). </para> <para> If this option is set, the importer instead automatically cleans the bucket of all uploaded content on error. </para> </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.UrlExpirationInDays"> <summary> The maximum age, in days, before the Amazon S3 presigned urls generated in the import manifest expire. The default value is 30. Note that for AWS regions that require Signature Version 4 request signing, the maximum value will not exceed 7 days. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.BucketName"> <summary> The name of the bucket that will hold the artifacts. An attempt will be made to create the bucket if it does not already exist. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.ArtifactsKeyPrefix"> <summary> S3 object key beneath which all artifacts will be uploaded in the bucket; by convention this is a GUID preceeded by any custom prefix the user has specified. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.Region"> <summary> The region in which the import will take place. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.S3Client"> <summary> Client for S3 operations, created using the credentials and region scoping we are handed on construction, or assigned from an existing S3 client instance. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.EC2Client"> <summary> Client for EC2 operations, created using the credentials and region scoping we are handed on construction, or assigned from an existing EC2 client instance. </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporter.UrlExpiryPeriod"> <summary> Returns the maximum age, in days, to use for expiry for Amazon S3 presigned urls. For regions that require Signature Version 4 request signing, this is limited to 7 days. </summary> </member> <member name="T:Amazon.EC2.Import.ImportManifestRoot"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents the root of the data contained in the conversion manifest. </para> </summary> </member> <member name="T:Amazon.EC2.Import.ImporterInfo"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents version and requester metadata for the conversion. </para> </summary> </member> <member name="T:Amazon.EC2.Import.Import"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents the root of the data describing the data slices of the image file that are to be uploaded to Amazon S3 and the requested size of the volume to hold the data after conversion. </para> </summary> </member> <member name="T:Amazon.EC2.Import.ImageFileParts"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents the list of 'slices' of the image file that is to be uploaded to Amazon S3, together with helper to return the next slice for processing during the upload process. </para> </summary> </member> <member name="M:Amazon.EC2.Import.ImageFileParts.#ctor"> <summary> Initializes an empty collection of parts </summary> </member> <member name="M:Amazon.EC2.Import.ImageFileParts.FetchNextPartForUpload(System.IO.Stream,System.Byte[]@)"> <summary> Returns the next part to be uploaded, with its data loaded into the supplied buffer. </summary> <remarks> We want to serialize read access to the image file stream so that we do not 'thrash' or encounter problems with a non-seekable stream, but at the same time parallelize the part uploads. Reading the data prior to returning the part instance data satisfies this requirement. </remarks> <param name="imageFileStream">The stream wrapping the image file.</param> <param name="buffer">Buffer into which the part data will be read.</param> <returns> The part to upload or null if the image file has now been consumed. </returns> <remarks> If an error occurs during a part upload, we currently cease yielding parts to all workers, causing them to expire cleanly 'asap'. This strategy allows us to change to a 'greedy' approach in future where we simply skip over the part in error and do as much uploading as we can before exit. </remarks> </member> <member name="M:Amazon.EC2.Import.ImageFileParts.RegisterUploadFailure"> <summary> Allows the upload threadpool workers to register that one or more parts failed to upload successfully. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFileParts.PartInstances"> <summary> The collection of parts making up the image. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFileParts.Count"> <summary> The number of parts in the image. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFileParts.HasFailedUploads"> <summary> True if any image file part failed to upload successfully. </summary> </member> <member name="T:Amazon.EC2.Import.ImageFilePart"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents a single 'slice' of the image file that is to be uploaded to Amazon S3. </para> </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePart.ByteRange"> <summary> The range of bytes representing the part. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePart.Key"> <summary> The Amazon S3 object key of the part. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePart.Index"> <summary> The sequence number of the part within the whole image. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePart.UploadCompleted"> <summary> Indicates whether the part upload completed successfully. </summary> </member> <member name="T:Amazon.EC2.Import.ImageFilePartByteRange"> <summary> <para> Serialization class for processing the import and conversion of a virtual machine image to a new Amazon EC2 instance, or a disk image to a new EBS volume. </para> <para> This class represents the offset and extent of a single 'slice' of the image file that is to be uploaded to Amazon S3. </para> </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePartByteRange.End"> <summary> The byte offset indicating the end of the range. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePartByteRange.Start"> <summary> The byte offset indicating the start of the range. </summary> </member> <member name="P:Amazon.EC2.Import.ImageFilePartByteRange.Extent"> <summary> The length of the byte range. </summary> </member> <member name="T:Amazon.EC2.Import.ImagePartUploadState"> <summary> State class used to pass data about the image part to be processed to the thread pool worker. </summary> </member> <member name="F:Amazon.EC2.Import.DiskImportErrorStage.GeneratingManifest"> <summary> Error was detected during construction of the import manifest/analysis of the image file </summary> </member> <member name="F:Amazon.EC2.Import.DiskImportErrorStage.ManifestInspection"> <summary> Error was detected during download/deserialization of a previously uploaded manifest </summary> </member> <member name="F:Amazon.EC2.Import.DiskImportErrorStage.UploadingManifest"> <summary> Error was detected during upload of the import manifest to S3 </summary> </member> <member name="F:Amazon.EC2.Import.DiskImportErrorStage.UploadingImageFile"> <summary> Error was detected during upload of the part artifacts making up the image file </summary> </member> <member name="F:Amazon.EC2.Import.DiskImportErrorStage.SendingImportRequest"> <summary> Error was detected during the sending of the request to EC2 to start conversion of the uploaded image file </summary> </member> <member name="T:Amazon.EC2.Import.DiskImageImporterException"> <summary> Wraps errors returned from the importer </summary> </member> <member name="P:Amazon.EC2.Import.DiskImageImporterException.Stage"> <summary> What stage the importer was at when the error occurred </summary> </member> <member name="T:Amazon.EC2.Import.ImportLaunchConfiguration"> <summary> Settings configuring the EC2 instance launch phase after an image file has been uploaded. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.InstanceType"> <summary> The Amazon EC2 instance type to launch for the conversion </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.Platform"> <summary> The instance operating system. Valid values: Windows | Linux </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.Architecture"> <summary> The architecture of the instance. Valid values: i386 | x86_64 </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.Description"> <summary> Optional description for the instance being imported. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.AvailabilityZone"> <summary> Optional availability zone to launch the instance into. If not specified one will be chosen for you by EC2. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.SecurityGroupNames"> <summary> One or more security group names. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can change the instance to use another security group. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.PrivateIpAddress"> <summary> [EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.SubnetId"> <summary> [EC2-VPC] The ID of the subnet to launch the instance into. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.EnableMonitoring"> <summary> Indicates whether to enable detailed monitoring for the instance. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.InstanceInitiatedShutdownBehavior"> <summary> Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Valid values: stop | terminate. </summary> </member> <member name="P:Amazon.EC2.Import.ImportLaunchConfiguration.AdditionalInfo"> <summary> Reserved for internal use. </summary> </member> <member name="T:Amazon.EC2.Import.CleanupProgressCallback"> <summary> Callback signature to report progress on the deletion of the artifacts. </summary> <param name="message">Describes the current in-progress task.</param> <param name="percentComplete">If not null, the percentage completion of the deletion process.</param> </member> <member name="T:Amazon.EC2.Import.ImportCleanup"> <summary> Collection of helper methods for removing VM image file artifacts from Amazon S3 after an instance or volume conversion has been performed. </summary> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint,System.String,System.Boolean,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the image file artifacts associated with the specified conversion task. If the task is still active, ignoreActiveTask must be set true to enable artifact deletion, which will cause the task to fail. Use this option at your own risk. </summary> <param name="awsCredentials"> Credentials to use to instantiate the Amazon EC2 and Amazon S3 clients needed to complete the operation. </param> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="conversionTaskId"> The ID of the conversion task that used the image file </param> <param name="ignoreActiveTask"> If true the artifacts are deleted even if the conversion task is still in progress </param> <param name="progressCallback">Optional progress callback</param> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.RegionEndpoint,System.String,System.Boolean,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the image file artifacts associated with the specified conversion task. If the task is still active, ignoreActiveTask must be set true to enable artifact deletion, which will cause the task to fail. Use this option at your own risk. </summary> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="conversionTaskId"> The ID of the conversion task that used the image file </param> <param name="ignoreActiveTask"> If true the artifacts are deleted even if the conversion task is still in progress </param> <param name="progressCallback">Optional progress callback</param> <remarks> Amazon EC2 and S3 clients will be constructed using the specified region and default credentials. </remarks> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.EC2.IAmazonEC2,Amazon.S3.IAmazonS3,System.String,System.Boolean,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the image file artifacts associated with the specified conversion task. If the task is still active, ignoreActiveTask must be set true to enable artifact deletion, which will cause the task to fail. Use this option at your own risk. </summary> <param name="ec2Client"> Amazon EC2 client to use in the process. This should have been instantiated with credentials that have access to the conversion task and the region in which the import was performed. </param> <param name="s3Client"> Amazon S3 client to use use in the process. This should have been instantiated with credentials that have access to the bucket containing the image file artifacts and the region in which the bucket exists. </param> <param name="conversionTaskId"> The ID of the conversion task that used the image file </param> <param name="ignoreActiveTask"> If true the artifacts are deleted even if the conversion task is still in progress </param> <param name="progressCallback">Optional progress callback</param> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using a presigned url to address the manifest for the import. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="awsCredentials"> Credentials to use to instantiate the Amazon EC2 and Amazon S3 clients needed to complete the operation. </param> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="manifestUrl"> Presigned URL to the import manifest file </param> <param name="progressCallback">Optional progress callback</param> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.RegionEndpoint,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using a presigned url to address the manifest for the import. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="manifestUrl"> Presigned URL to the import manifest file </param> <param name="progressCallback">Optional progress callback</param> <remarks> An Amazon S3 client will be constructed using the specified region and default credentials. </remarks> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.S3.IAmazonS3,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using a presigned url to address the manifest for the import. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="s3Client"> An Amazon S3 client for the operation to use. This should have been constructed using credentials that have access to the bucket containing the image file artifacts and be scoped to the region containing the bucket. </param> <param name="manifestUrl"> Presigned URL to the import manifest file </param> <param name="progressCallback">Optional progress callback</param> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint,System.String,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using the bucket name and key prefix to the artifacts in Amazon S3. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="awsCredentials"> Credentials to use to instantiate the Amazon EC2 and Amazon S3 clients needed to complete the operation. </param> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="bucketName">The name of the bucket containing the artifacts</param> <param name="keyPrefix">The common key prefix of the artifacts</param> <param name="progressCallback">Optional progress callback</param> <remarks> An Amazon S3 client will be constructed using the specified region and credentials. </remarks> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.RegionEndpoint,System.String,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using the bucket name and key prefix to the artifacts in Amazon S3. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="region"> The region containing the bucket where the image file artifacts were stored </param> <param name="bucketName">The name of the bucket containing the artifacts</param> <param name="keyPrefix">The common key prefix of the artifacts</param> <param name="progressCallback">Optional progress callback</param> <remarks> An Amazon S3 client will be constructed using the specified region and default profile credentials. </remarks> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.DeleteImageArtifacts(Amazon.S3.IAmazonS3,System.String,System.String,Amazon.EC2.Import.CleanupProgressCallback)"> <summary> Deletes the artifacts associated with an import task using the bucket name and key prefix to the artifacts in Amazon S3. No check is performed to determine whether the associated conversion task is in progress. </summary> <param name="s3Client"> An Amazon S3 client for the operation to use. This should have been constructed using credentials that have access to the bucket containing the image file artifacts and be scoped to the region containing the bucket. </param> <param name="bucketName">The name of the bucket containing the artifacts</param> <param name="keyPrefix">The common key prefix of the artifacts</param> <param name="progressCallback">Optional progress callback</param> </member> <member name="M:Amazon.EC2.Import.ImportCleanup.SendProgressNotification(Amazon.EC2.Import.CleanupProgressCallback,System.String,System.Nullable{System.Int32})"> <summary> Callback processing if the caller supplied a delegate. </summary> <param name="progressCallback"> The callback delegate that was supplied, or null if progress updates were not requested </param> <param name="msg">A message describing the current state of the cleanup process</param> <param name="percentComplete">When the deletion phase of the cleanup process starts, set to the percentage of image file artifacts deleted so far </param> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2PostMarshallHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2PostMarshallHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2PreMarshallHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2PreMarshallHandler.InvokeAsync(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls pre invoke logic before calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> <returns>IAsyncResult which represent an async operation.</returns> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2ResponseHandler.InvokeSync(Amazon.Runtime.IExecutionContext)"> <summary> Calls the post invoke logic after calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context which contains both the requests and response context.</param> </member> <member name="M:Amazon.EC2.Internal.AmazonEC2ResponseHandler.InvokeAsyncCallback(Amazon.Runtime.IAsyncExecutionContext)"> <summary> Calls the PostInvoke methods after calling the next handler in the pipeline. </summary> <param name="executionContext">The execution context, it contains the request and response context.</param> </member> <member name="T:Amazon.EC2.Internal.CustomMarshallTransformations"> <summary> Custom type serializers for EC2 </summary> </member> <member name="M:Amazon.EC2.Internal.CustomMarshallTransformations.ConvertDateTimeISOWithoutMilliseconds(System.DateTime)"> <summary> Custom DateTime serializer for EC2. </summary> <param name="dateTime">The DateTime to serialize</param> <returns>ISO formatted string with no miliseconds</returns> </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.IAmazonEC2,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.LaunchVPCWithPublicSubnetRequest.EnableDnsHostnames"> <summary> Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not. If you want your instances to get DNS hostnames, you must also set the enableDnsSupport attribute to true. </summary> </member> <member name="P:Amazon.EC2.Util.LaunchVPCWithPublicSubnetRequest.EnableDnsSupport"> <summary> Indicates whether the DNS resolution is supported for the VPC. If this attribute is false, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. If this attribute is true, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" will succeed. For more information, see <a href="http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html#AmazonDNS">Amazon DNS Server</a>. </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.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.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.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.FindNATImage(Amazon.EC2.IAmazonEC2)"> <summary> Find the current VPC NAT image in the region for the AmazonEC2 client. </summary> <param name="ec2Client">The ec2client used to look up the image.</param> <returns>The image</returns> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.FindNATImage(Amazon.EC2.IAmazonEC2,Amazon.EC2.VirtualizationType)"> <summary> Find the current VPC NAT image in the region for the AmazonEC2 client. </summary> <param name="ec2Client">The ec2client used to look up the image.</param> <param name="vt">The virtualization type of the AMI to look for.</param> <returns>The image</returns> </member> <member name="M:Amazon.EC2.Util.VPCUtilities.LaunchNATInstance(Amazon.EC2.IAmazonEC2,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.IAmazonEC2,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.IAmazonEC2,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.IAmazonEC2,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.ECS.AmazonECSClient"> <summary> Implementation for accessing ECS Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles. <para> You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure. </para> </summary> </member> <member name="T:Amazon.ECS.IAmazonECS"> <summary> Interface for accessing ECS Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles. <para> You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure. </para> </summary> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateCluster(Amazon.ECS.Model.CreateClusterRequest)"> <summary> Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginCreateCluster(Amazon.ECS.Model.CreateClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCluster operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndCreateCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCluster operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCluster.</param> <returns>Returns a CreateClusterResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.CreateService(Amazon.ECS.Model.CreateServiceRequest)"> <summary> Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>. <para> You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateService service method.</param> <returns>The response from the CreateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginCreateService(Amazon.ECS.Model.CreateServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateService operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateService operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndCreateService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateService.</param> <returns>Returns a CreateServiceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteCluster(Amazon.ECS.Model.DeleteClusterRequest)"> <summary> Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsContainerInstancesException"> You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see <a>DeregisterContainerInstance</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsServicesException"> You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see <a>UpdateService</a> and <a>DeleteService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDeleteCluster(Amazon.ECS.Model.DeleteClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCluster operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDeleteCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCluster operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCluster.</param> <returns>Returns a DeleteClusterResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeleteService(Amazon.ECS.Model.DeleteServiceRequest)"> <summary> Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>. <note> <para> When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteService service method.</param> <returns>The response from the DeleteService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDeleteService(Amazon.ECS.Model.DeleteServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteService operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteService operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDeleteService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteService.</param> <returns>Returns a DeleteServiceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest)"> <summary> Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para> <para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para> <note> <para> When you terminate a container instance, it is automatically deregistered from your cluster. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance service method.</param> <returns>The response from the DeregisterContainerInstance service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterContainerInstance operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDeregisterContainerInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterContainerInstance.</param> <returns>Returns a DeregisterContainerInstanceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest)"> <summary> Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition service method.</param> <returns>The response from the DeregisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDeregisterTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterTaskDefinition.</param> <returns>Returns a DeregisterTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeClusters(Amazon.ECS.Model.DescribeClustersRequest)"> <summary> Describes one or more of your clusters. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDescribeClusters(Amazon.ECS.Model.DescribeClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeClusters operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDescribeClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeClusters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeClusters.</param> <returns>Returns a DescribeClustersResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest)"> <summary> Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances service method.</param> <returns>The response from the DescribeContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeContainerInstances operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDescribeContainerInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeContainerInstances.</param> <returns>Returns a DescribeContainerInstancesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeServices(Amazon.ECS.Model.DescribeServicesRequest)"> <summary> Describes the specified services running in your cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDescribeServices(Amazon.ECS.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.ECS.IAmazonECS.EndDescribeServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest)"> <summary> Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note> <para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition service method.</param> <returns>The response from the DescribeTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDescribeTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTaskDefinition.</param> <returns>Returns a DescribeTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.DescribeTasks(Amazon.ECS.Model.DescribeTasksRequest)"> <summary> Describes a specified task or tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks service method.</param> <returns>The response from the DescribeTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginDescribeTasks(Amazon.ECS.Model.DescribeTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTasks operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndDescribeTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTasks.</param> <returns>Returns a DescribeTasksResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListClusters(Amazon.ECS.Model.ListClustersRequest)"> <summary> Returns a list of existing clusters. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListClusters(Amazon.ECS.Model.ListClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.ECS.IAmazonECS.EndListClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListClusters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListClusters.</param> <returns>Returns a ListClustersResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest)"> <summary> Returns a list of container instances in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances service method.</param> <returns>The response from the ListContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListContainerInstances operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndListContainerInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListContainerInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListContainerInstances.</param> <returns>Returns a ListContainerInstancesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListServices(Amazon.ECS.Model.ListServicesRequest)"> <summary> Lists the services that are running in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListServices service method.</param> <returns>The response from the ListServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListServices(Amazon.ECS.Model.ListServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListServices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServices operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListServices operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndListServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListServices.</param> <returns>Returns a ListServicesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest)"> <summary> Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method.</param> <returns>The response from the ListTaskDefinitionFamilies service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTaskDefinitionFamilies operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndListTaskDefinitionFamilies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTaskDefinitionFamilies.</param> <returns>Returns a ListTaskDefinitionFamiliesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest)"> <summary> Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions service method.</param> <returns>The response from the ListTaskDefinitions service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTaskDefinitions operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndListTaskDefinitions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTaskDefinitions.</param> <returns>Returns a ListTaskDefinitionsResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.ListTasks(Amazon.ECS.Model.ListTasksRequest)"> <summary> Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks service method.</param> <returns>The response from the ListTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginListTasks(Amazon.ECS.Model.ListTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTasks operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndListTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTasks.</param> <returns>Returns a ListTasksResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.RegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest)"> <summary> Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition service method.</param> <returns>The response from the RegisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginRegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndRegisterTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterTaskDefinition.</param> <returns>Returns a RegisterTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.RunTask(Amazon.ECS.Model.RunTaskRequest)"> <summary> Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the RunTask service method.</param> <returns>The response from the RunTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginRunTask(Amazon.ECS.Model.RunTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunTask operation. </summary> <param name="request">Container for the necessary parameters to execute the RunTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunTask operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndRunTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunTask.</param> <returns>Returns a RunTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.StartTask(Amazon.ECS.Model.StartTaskRequest)"> <summary> Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the StartTask service method.</param> <returns>The response from the StartTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginStartTask(Amazon.ECS.Model.StartTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StartTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTask operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndStartTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartTask.</param> <returns>Returns a StartTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.StopTask(Amazon.ECS.Model.StopTaskRequest)"> <summary> Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopTask service method.</param> <returns>The response from the StopTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginStopTask(Amazon.ECS.Model.StopTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StopTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopTask operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndStopTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopTask.</param> <returns>Returns a StopTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest)"> <summary> Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. <para> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent service method.</param> <returns>The response from the UpdateContainerAgent service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.MissingVersionException"> Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information. </exception> <exception cref="T:Amazon.ECS.Model.NoUpdateAvailableException"> There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.UpdateInProgressException"> There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginUpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateContainerAgent operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndUpdateContainerAgent(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateContainerAgent.</param> <returns>Returns a UpdateContainerAgentResult from ECS.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.UpdateService(Amazon.ECS.Model.UpdateServiceRequest)"> <summary> Modifies the desired count, deployment configuration, or task definition used in a service. <para> You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter. </para> <para> You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service. </para> <para> You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). </para> <para> When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param> <returns>The response from the UpdateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotActiveException"> The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with <a>CreateService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.IAmazonECS.BeginUpdateService(Amazon.ECS.Model.UpdateServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateService operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateService operation.</returns> </member> <member name="M:Amazon.ECS.IAmazonECS.EndUpdateService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateService.</param> <returns>Returns a UpdateServiceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonECSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Credentials and an AmazonECSClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an AmazonECSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonECSClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.#ctor(System.String,System.String,System.String,Amazon.ECS.AmazonECSConfig)"> <summary> Constructs AmazonECSClient with AWS Access Key ID, AWS Secret Key and an AmazonECSClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonECSClient Configuration Object</param> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateCluster(Amazon.ECS.Model.CreateClusterRequest)"> <summary> Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster service method.</param> <returns>The response from the CreateCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginCreateCluster(Amazon.ECS.Model.CreateClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateCluster operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCluster operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndCreateCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateCluster operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateCluster.</param> <returns>Returns a CreateClusterResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.CreateService(Amazon.ECS.Model.CreateServiceRequest)"> <summary> Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>. <para> You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the CreateService service method.</param> <returns>The response from the CreateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginCreateService(Amazon.ECS.Model.CreateServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the CreateService operation. </summary> <param name="request">Container for the necessary parameters to execute the CreateService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateService operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndCreateService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the CreateService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginCreateService.</param> <returns>Returns a CreateServiceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteCluster(Amazon.ECS.Model.DeleteClusterRequest)"> <summary> Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster service method.</param> <returns>The response from the DeleteCluster service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsContainerInstancesException"> You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see <a>DeregisterContainerInstance</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterContainsServicesException"> You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see <a>UpdateService</a> and <a>DeleteService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDeleteCluster(Amazon.ECS.Model.DeleteClusterRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteCluster operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteCluster operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCluster operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDeleteCluster(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteCluster operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteCluster.</param> <returns>Returns a DeleteClusterResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeleteService(Amazon.ECS.Model.DeleteServiceRequest)"> <summary> Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>. <note> <para> When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeleteService service method.</param> <returns>The response from the DeleteService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDeleteService(Amazon.ECS.Model.DeleteServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeleteService operation. </summary> <param name="request">Container for the necessary parameters to execute the DeleteService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteService operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDeleteService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeleteService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeleteService.</param> <returns>Returns a DeleteServiceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest)"> <summary> Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para> <para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para> <note> <para> When you terminate a container instance, it is automatically deregistered from your cluster. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance service method.</param> <returns>The response from the DeregisterContainerInstance service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDeregisterContainerInstance(Amazon.ECS.Model.DeregisterContainerInstanceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterContainerInstance operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterContainerInstance operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDeregisterContainerInstance(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterContainerInstance operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterContainerInstance.</param> <returns>Returns a DeregisterContainerInstanceResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest)"> <summary> Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition service method.</param> <returns>The response from the DeregisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDeregisterTaskDefinition(Amazon.ECS.Model.DeregisterTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DeregisterTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeregisterTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDeregisterTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DeregisterTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDeregisterTaskDefinition.</param> <returns>Returns a DeregisterTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeClusters(Amazon.ECS.Model.DescribeClustersRequest)"> <summary> Describes one or more of your clusters. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters service method.</param> <returns>The response from the DescribeClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDescribeClusters(Amazon.ECS.Model.DescribeClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeClusters operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeClusters operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDescribeClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeClusters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeClusters.</param> <returns>Returns a DescribeClustersResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest)"> <summary> Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances service method.</param> <returns>The response from the DescribeContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDescribeContainerInstances(Amazon.ECS.Model.DescribeContainerInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeContainerInstances operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeContainerInstances operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDescribeContainerInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeContainerInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeContainerInstances.</param> <returns>Returns a DescribeContainerInstancesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeServices(Amazon.ECS.Model.DescribeServicesRequest)"> <summary> Describes the specified services running in your cluster. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices service method.</param> <returns>The response from the DescribeServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDescribeServices(Amazon.ECS.Model.DescribeServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeServices operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeServices operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.ECS.AmazonECSClient.EndDescribeServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeServices.</param> <returns>Returns a DescribeServicesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest)"> <summary> Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note> <para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para> </note> </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition service method.</param> <returns>The response from the DescribeTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDescribeTaskDefinition(Amazon.ECS.Model.DescribeTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDescribeTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTaskDefinition.</param> <returns>Returns a DescribeTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.DescribeTasks(Amazon.ECS.Model.DescribeTasksRequest)"> <summary> Describes a specified task or tasks. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks service method.</param> <returns>The response from the DescribeTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginDescribeTasks(Amazon.ECS.Model.DescribeTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the DescribeTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the DescribeTasks operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeTasks operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndDescribeTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the DescribeTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginDescribeTasks.</param> <returns>Returns a DescribeTasksResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListClusters(Amazon.ECS.Model.ListClustersRequest)"> <summary> Returns a list of existing clusters. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters service method.</param> <returns>The response from the ListClusters service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListClusters(Amazon.ECS.Model.ListClustersRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListClusters operation. </summary> <param name="request">Container for the necessary parameters to execute the ListClusters operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState 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.ECS.AmazonECSClient.EndListClusters(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListClusters operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListClusters.</param> <returns>Returns a ListClustersResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest)"> <summary> Returns a list of container instances in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances service method.</param> <returns>The response from the ListContainerInstances service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListContainerInstances(Amazon.ECS.Model.ListContainerInstancesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListContainerInstances operation. </summary> <param name="request">Container for the necessary parameters to execute the ListContainerInstances operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListContainerInstances operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndListContainerInstances(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListContainerInstances operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListContainerInstances.</param> <returns>Returns a ListContainerInstancesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListServices(Amazon.ECS.Model.ListServicesRequest)"> <summary> Lists the services that are running in a specified cluster. </summary> <param name="request">Container for the necessary parameters to execute the ListServices service method.</param> <returns>The response from the ListServices service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListServices(Amazon.ECS.Model.ListServicesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListServices operation. </summary> <param name="request">Container for the necessary parameters to execute the ListServices operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListServices operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndListServices(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListServices operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListServices.</param> <returns>Returns a ListServicesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest)"> <summary> Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method.</param> <returns>The response from the ListTaskDefinitionFamilies service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListTaskDefinitionFamilies(Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTaskDefinitionFamilies operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndListTaskDefinitionFamilies(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTaskDefinitionFamilies operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTaskDefinitionFamilies.</param> <returns>Returns a ListTaskDefinitionFamiliesResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest)"> <summary> Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions service method.</param> <returns>The response from the ListTaskDefinitions service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListTaskDefinitions(Amazon.ECS.Model.ListTaskDefinitionsRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTaskDefinitions operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTaskDefinitions operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndListTaskDefinitions(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTaskDefinitions operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTaskDefinitions.</param> <returns>Returns a ListTaskDefinitionsResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.ListTasks(Amazon.ECS.Model.ListTasksRequest)"> <summary> Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks service method.</param> <returns>The response from the ListTasks service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginListTasks(Amazon.ECS.Model.ListTasksRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the ListTasks operation. </summary> <param name="request">Container for the necessary parameters to execute the ListTasks operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTasks operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndListTasks(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the ListTasks operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginListTasks.</param> <returns>Returns a ListTasksResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.RegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest)"> <summary> Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition service method.</param> <returns>The response from the RegisterTaskDefinition service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginRegisterTaskDefinition(Amazon.ECS.Model.RegisterTaskDefinitionRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="request">Container for the necessary parameters to execute the RegisterTaskDefinition operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterTaskDefinition operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndRegisterTaskDefinition(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RegisterTaskDefinition operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRegisterTaskDefinition.</param> <returns>Returns a RegisterTaskDefinitionResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.RunTask(Amazon.ECS.Model.RunTaskRequest)"> <summary> Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the RunTask service method.</param> <returns>The response from the RunTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginRunTask(Amazon.ECS.Model.RunTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the RunTask operation. </summary> <param name="request">Container for the necessary parameters to execute the RunTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRunTask operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndRunTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the RunTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginRunTask.</param> <returns>Returns a RunTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.StartTask(Amazon.ECS.Model.StartTaskRequest)"> <summary> Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> <param name="request">Container for the necessary parameters to execute the StartTask service method.</param> <returns>The response from the StartTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginStartTask(Amazon.ECS.Model.StartTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StartTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StartTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTask operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndStartTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StartTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStartTask.</param> <returns>Returns a StartTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.StopTask(Amazon.ECS.Model.StopTaskRequest)"> <summary> Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> <param name="request">Container for the necessary parameters to execute the StopTask service method.</param> <returns>The response from the StopTask service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginStopTask(Amazon.ECS.Model.StopTaskRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the StopTask operation. </summary> <param name="request">Container for the necessary parameters to execute the StopTask operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopTask operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndStopTask(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the StopTask operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginStopTask.</param> <returns>Returns a StopTaskResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest)"> <summary> Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system. <para> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent service method.</param> <returns>The response from the UpdateContainerAgent service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.MissingVersionException"> Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information. </exception> <exception cref="T:Amazon.ECS.Model.NoUpdateAvailableException"> There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.UpdateInProgressException"> There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginUpdateContainerAgent(Amazon.ECS.Model.UpdateContainerAgentRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateContainerAgent operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateContainerAgent operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndUpdateContainerAgent(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateContainerAgent operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateContainerAgent.</param> <returns>Returns a UpdateContainerAgentResult from ECS.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.UpdateService(Amazon.ECS.Model.UpdateServiceRequest)"> <summary> Modifies the desired count, deployment configuration, or task definition used in a service. <para> You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter. </para> <para> You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service. </para> <para> You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). </para> <para> When <a>UpdateService</a> stops a task during a deployment, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the UpdateService service method.</param> <returns>The response from the UpdateService service method, as returned by ECS.</returns> <exception cref="T:Amazon.ECS.Model.ClientException"> These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </exception> <exception cref="T:Amazon.ECS.Model.ClusterNotFoundException"> The specified cluster could not be found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are region-specific. </exception> <exception cref="T:Amazon.ECS.Model.InvalidParameterException"> The specified parameter is invalid. Review the available parameters for the API request. </exception> <exception cref="T:Amazon.ECS.Model.ServerException"> These errors are usually caused by a server issue. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotActiveException"> The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with <a>CreateService</a>. </exception> <exception cref="T:Amazon.ECS.Model.ServiceNotFoundException"> The specified service could not be found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster-specific and region-specific. </exception> </member> <member name="M:Amazon.ECS.AmazonECSClient.BeginUpdateService(Amazon.ECS.Model.UpdateServiceRequest,System.AsyncCallback,System.Object)"> <summary> Initiates the asynchronous execution of the UpdateService operation. </summary> <param name="request">Container for the necessary parameters to execute the UpdateService operation on AmazonECSClient.</param> <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param> <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback procedure using the AsyncState property.</param> <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateService operation.</returns> </member> <member name="M:Amazon.ECS.AmazonECSClient.EndUpdateService(System.IAsyncResult)"> <summary> Finishes the asynchronous execution of the UpdateService operation. </summary> <param name="asyncResult">The IAsyncResult returned by the call to BeginUpdateService.</param> <returns>Returns a UpdateServiceResult from ECS.</returns> </member> <member name="T:Amazon.ECS.AmazonECSConfig"> <summary> Configuration for accessing Amazon ECS service </summary> </member> <member name="M:Amazon.ECS.AmazonECSConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.ECS.AmazonECSConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.ECS.AmazonECSConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="T:Amazon.ECS.AgentUpdateStatus"> <summary> Constants used for properties of type AgentUpdateStatus. </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.FAILED"> <summary> Constant FAILED for AgentUpdateStatus </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.PENDING"> <summary> Constant PENDING for AgentUpdateStatus </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.STAGED"> <summary> Constant STAGED for AgentUpdateStatus </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.STAGING"> <summary> Constant STAGING for AgentUpdateStatus </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.UPDATED"> <summary> Constant UPDATED for AgentUpdateStatus </summary> </member> <member name="F:Amazon.ECS.AgentUpdateStatus.UPDATING"> <summary> Constant UPDATING for AgentUpdateStatus </summary> </member> <member name="M:Amazon.ECS.AgentUpdateStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.AgentUpdateStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.DesiredStatus"> <summary> Constants used for properties of type DesiredStatus. </summary> </member> <member name="F:Amazon.ECS.DesiredStatus.PENDING"> <summary> Constant PENDING for DesiredStatus </summary> </member> <member name="F:Amazon.ECS.DesiredStatus.RUNNING"> <summary> Constant RUNNING for DesiredStatus </summary> </member> <member name="F:Amazon.ECS.DesiredStatus.STOPPED"> <summary> Constant STOPPED for DesiredStatus </summary> </member> <member name="M:Amazon.ECS.DesiredStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.DesiredStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.LogDriver"> <summary> Constants used for properties of type LogDriver. </summary> </member> <member name="F:Amazon.ECS.LogDriver.Fluentd"> <summary> Constant Fluentd for LogDriver </summary> </member> <member name="F:Amazon.ECS.LogDriver.Gelf"> <summary> Constant Gelf for LogDriver </summary> </member> <member name="F:Amazon.ECS.LogDriver.Journald"> <summary> Constant Journald for LogDriver </summary> </member> <member name="F:Amazon.ECS.LogDriver.JsonFile"> <summary> Constant JsonFile for LogDriver </summary> </member> <member name="F:Amazon.ECS.LogDriver.Syslog"> <summary> Constant Syslog for LogDriver </summary> </member> <member name="M:Amazon.ECS.LogDriver.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.LogDriver.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.SortOrder"> <summary> Constants used for properties of type SortOrder. </summary> </member> <member name="F:Amazon.ECS.SortOrder.ASC"> <summary> Constant ASC for SortOrder </summary> </member> <member name="F:Amazon.ECS.SortOrder.DESC"> <summary> Constant DESC for SortOrder </summary> </member> <member name="M:Amazon.ECS.SortOrder.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.SortOrder.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.TaskDefinitionStatus"> <summary> Constants used for properties of type TaskDefinitionStatus. </summary> </member> <member name="F:Amazon.ECS.TaskDefinitionStatus.ACTIVE"> <summary> Constant ACTIVE for TaskDefinitionStatus </summary> </member> <member name="F:Amazon.ECS.TaskDefinitionStatus.INACTIVE"> <summary> Constant INACTIVE for TaskDefinitionStatus </summary> </member> <member name="M:Amazon.ECS.TaskDefinitionStatus.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.TaskDefinitionStatus.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.TransportProtocol"> <summary> Constants used for properties of type TransportProtocol. </summary> </member> <member name="F:Amazon.ECS.TransportProtocol.Tcp"> <summary> Constant Tcp for TransportProtocol </summary> </member> <member name="F:Amazon.ECS.TransportProtocol.Udp"> <summary> Constant Udp for TransportProtocol </summary> </member> <member name="M:Amazon.ECS.TransportProtocol.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.TransportProtocol.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.UlimitName"> <summary> Constants used for properties of type UlimitName. </summary> </member> <member name="F:Amazon.ECS.UlimitName.Core"> <summary> Constant Core for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Cpu"> <summary> Constant Cpu for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Data"> <summary> Constant Data for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Fsize"> <summary> Constant Fsize for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Locks"> <summary> Constant Locks for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Memlock"> <summary> Constant Memlock for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Msgqueue"> <summary> Constant Msgqueue for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Nice"> <summary> Constant Nice for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Nofile"> <summary> Constant Nofile for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Nproc"> <summary> Constant Nproc for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Rss"> <summary> Constant Rss for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Rtprio"> <summary> Constant Rtprio for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Rttime"> <summary> Constant Rttime for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Sigpending"> <summary> Constant Sigpending for UlimitName </summary> </member> <member name="F:Amazon.ECS.UlimitName.Stack"> <summary> Constant Stack for UlimitName </summary> </member> <member name="M:Amazon.ECS.UlimitName.#ctor(System.String)"> <summary> Default Constructor </summary> </member> <member name="M:Amazon.ECS.UlimitName.FindValue(System.String)"> <summary> Finds the constant for the unique value. </summary> <param name="value">The unique value for the constant</param> <returns>The constant for the unique value</returns> </member> <member name="T:Amazon.ECS.AmazonECSRequest"> <summary> Base class for ECS operation requests. </summary> </member> <member name="T:Amazon.ECS.Model.Attribute"> <summary> The attributes applicable to a container instance when it is registered. </summary> </member> <member name="P:Amazon.ECS.Model.Attribute.Name"> <summary> Gets and sets the property Name. <para> The name of the container instance attribute. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Attribute.Value"> <summary> Gets and sets the property Value. <para> The value of the container instance attribute (at this time, the value here is <code>Null</code>, but this could change in future revisions for expandability). </para> </summary> </member> <member name="T:Amazon.ECS.Model.ClientException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ClientException.#ctor(System.String)"> <summary> Constructs a new ClientException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.Cluster"> <summary> A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously. </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.ActiveServicesCount"> <summary> Gets and sets the property ActiveServicesCount. <para> The number of services that are running on the cluster in an <code>ACTIVE</code> state. You can view these services with <a>ListServices</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.ClusterArn"> <summary> Gets and sets the property ClusterArn. <para> The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, arn:aws:ecs:<i>region</i>:<i>012345678910</i>:cluster/<i>test</i>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.ClusterName"> <summary> Gets and sets the property ClusterName. <para> A user-generated string that you use to identify your cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.PendingTasksCount"> <summary> Gets and sets the property PendingTasksCount. <para> The number of tasks in the cluster that are in the <code>PENDING</code> state. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.RegisteredContainerInstancesCount"> <summary> Gets and sets the property RegisteredContainerInstancesCount. <para> The number of container instances registered into the cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.RunningTasksCount"> <summary> Gets and sets the property RunningTasksCount. <para> The number of tasks in the cluster that are in the <code>RUNNING</code> state. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Cluster.Status"> <summary> Gets and sets the property Status. <para> The status of the cluster. The valid values are <code>ACTIVE</code> or <code>INACTIVE</code>. <code>ACTIVE</code> indicates that you can register container instances with the cluster and the associated instances can accept tasks. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ClusterContainsContainerInstancesException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ClusterContainsContainerInstancesException.#ctor(System.String)"> <summary> Constructs a new ClusterContainsContainerInstancesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.ClusterContainsServicesException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ClusterContainsServicesException.#ctor(System.String)"> <summary> Constructs a new ClusterContainsServicesException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.ClusterNotFoundException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ClusterNotFoundException.#ctor(System.String)"> <summary> Constructs a new ClusterNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.Container"> <summary> A Docker container that is part of a task. </summary> </member> <member name="P:Amazon.ECS.Model.Container.ContainerArn"> <summary> Gets and sets the property ContainerArn. <para> The Amazon Resource Name (ARN) of the container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.ExitCode"> <summary> Gets and sets the property ExitCode. <para> The exit code returned from the container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.LastStatus"> <summary> Gets and sets the property LastStatus. <para> The last known status of the container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.Name"> <summary> Gets and sets the property Name. <para> The name of the container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.NetworkBindings"> <summary> Gets and sets the property NetworkBindings. <para> The network bindings associated with the container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.Reason"> <summary> Gets and sets the property Reason. <para> A short (255 max characters) human-readable string to provide additional detail about a running or stopped container. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Container.TaskArn"> <summary> Gets and sets the property TaskArn. <para> The Amazon Resource Name (ARN) of the task. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ContainerDefinition"> <summary> Container definitions are used in task definitions to describe the different containers that are launched as part of a task. </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Command"> <summary> Gets and sets the property Command. <para> The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. For more information, see <a href="https://docs.docker.com/reference/builder/#cmd">https://docs.docker.com/reference/builder/#cmd</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Cpu"> <summary> Gets and sets the property Cpu. <para> The number of <code>cpu</code> units reserved for the container. A container instance has 1,024 <code>cpu</code> units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to <code>CpuShares</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> <note> <para> You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instances</a> detail page by 1,024. </para> </note> <para> For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units. </para> <para> The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href="https://docs.docker.com/reference/run/#cpu-share-constraint">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: </para> <ul> <li><b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</li> <li><b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</li></ul> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.DisableNetworking"> <summary> Gets and sets the property DisableNetworking. <para> When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.DnsSearchDomains"> <summary> Gets and sets the property DnsSearchDomains. <para> A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--dns-search</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.DnsServers"> <summary> Gets and sets the property DnsServers. <para> A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--dns</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.DockerLabels"> <summary> Gets and sets the property DockerLabels. <para> A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--label</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep "Server API version"</code> </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.DockerSecurityOptions"> <summary> Gets and sets the property DockerSecurityOptions. <para> A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to <code>SecurityOpt</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--security-opt</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> <note> <para> The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.EntryPoint"> <summary> Gets and sets the property EntryPoint. <important> <para> Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead. </para> </important> <para> The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. For more information, see <a href="https://docs.docker.com/reference/builder/#entrypoint">https://docs.docker.com/reference/builder/#entrypoint</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Environment"> <summary> Gets and sets the property Environment. <para> The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--env</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> <important> <para> We do not recommend using plain text environment variables for sensitive information, such as credential data. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Essential"> <summary> Gets and sets the property Essential. <para> If the <code>essential</code> parameter of a container is marked as <code>true</code>, the failure of that container stops the task. If the <code>essential</code> parameter of a container is marked as <code>false</code>, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. </para> <note> <para> All tasks must have at least one essential container. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.ExtraHosts"> <summary> Gets and sets the property ExtraHosts. <para> A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. This parameter maps to <code>ExtraHosts</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--add-host</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Hostname"> <summary> Gets and sets the property Hostname. <para> The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--hostname</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Image"> <summary> Gets and sets the property Image. <para> The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code><i>repository-url</i>/<i>image</i>:<i>tag</i></code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> <ul> <li>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</li> <li>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</li> <li>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</li> </ul> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Links"> <summary> Gets and sets the property Links. <para> The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings, using the <code>name</code> parameter and optionally, an <code>alias</code> for the link. This construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each <code>name</code> and <code>alias</code>. For more information on linking Docker containers, see <a href="https://docs.docker.com/userguide/dockerlinks/">https://docs.docker.com/userguide/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--link</code> option to <a href="https://docs.docker.com/reference/commandline/run/"><code>docker run</code></a>. </para> <important> <para> Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.LogConfiguration"> <summary> Gets and sets the property LogConfiguration. <para> The log configuration specification for the container. This parameter maps to <code>LogConfig</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--log-driver</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. Valid log drivers are displayed in the <a>LogConfiguration</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep "Server API version"</code> </para> <note> <para> The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Memory"> <summary> Gets and sets the property Memory. <para> The number of MiB of memory to reserve for the container. You must specify a non-zero integer for this parameter; the Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. If your container attempts to exceed the memory allocated here, the container is killed. This parameter maps to <code>Memory</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--memory</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.MountPoints"> <summary> Gets and sets the property MountPoints. <para> The mount points for data volumes in your container. This parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--volume</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Name"> <summary> Gets and sets the property Name. <para> The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--name</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.PortMappings"> <summary> Gets and sets the property PortMappings. <para> The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to <code>PortBindings</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--publish</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> <note> <para> After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description of a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Privileged"> <summary> Gets and sets the property Privileged. <para> When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--privileged</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.ReadonlyRootFilesystem"> <summary> Gets and sets the property ReadonlyRootFilesystem. <para> When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.Ulimits"> <summary> Gets and sets the property Ulimits. <para> A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--ulimit</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep "Server API version"</code> </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.User"> <summary> Gets and sets the property User. <para> The user name to use inside the container. This parameter maps to <code>User</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--user</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.VolumesFrom"> <summary> Gets and sets the property VolumesFrom. <para> Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerDefinition.WorkingDirectory"> <summary> Gets and sets the property WorkingDirectory. <para> The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <a href="https://docs.docker.com/reference/api/docker_remote_api_v1.19/">Docker Remote API</a> and the <code>--workdir</code> option to <a href="https://docs.docker.com/reference/commandline/run/">docker run</a>. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ContainerInstance"> <summary> An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster. </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.AgentConnected"> <summary> Gets and sets the property AgentConnected. <para> This parameter returns <code>true</code> if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>, and instances without a connected agent cannot accept placement requests. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.AgentUpdateStatus"> <summary> Gets and sets the property AgentUpdateStatus. <para> The status of the most recent agent update. If an update has never been requested, this value is <code>NULL</code>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.Attributes"> <summary> Gets and sets the property Attributes. <para> The attributes set for the container instance by the Amazon ECS container agent at instance registration. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.ContainerInstanceArn"> <summary> Gets and sets the property ContainerInstanceArn. <para> The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.Ec2InstanceId"> <summary> Gets and sets the property Ec2InstanceId. <para> The EC2 instance ID of the container instance. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.PendingTasksCount"> <summary> Gets and sets the property PendingTasksCount. <para> The number of tasks on the container instance that are in the <code>PENDING</code> status. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.RegisteredResources"> <summary> Gets and sets the property RegisteredResources. <para> The registered resources on the container instance that are in use by current tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.RemainingResources"> <summary> Gets and sets the property RemainingResources. <para> The remaining resources of the container instance that are available for new tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.RunningTasksCount"> <summary> Gets and sets the property RunningTasksCount. <para> The number of tasks on the container instance that are in the <code>RUNNING</code> status. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.Status"> <summary> Gets and sets the property Status. <para> The status of the container instance. The valid values are <code>ACTIVE</code> or <code>INACTIVE</code>. <code>ACTIVE</code> indicates that the container instance can accept tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerInstance.VersionInfo"> <summary> Gets and sets the property VersionInfo. <para> The version information for the Amazon ECS container agent and Docker daemon running on the container instance. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ContainerOverride"> <summary> The overrides that should be sent to a container. </summary> </member> <member name="P:Amazon.ECS.Model.ContainerOverride.Command"> <summary> Gets and sets the property Command. <para> The command to send to the container that overrides the default command from the Docker image or the task definition. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerOverride.Environment"> <summary> Gets and sets the property Environment. <para> The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ContainerOverride.Name"> <summary> Gets and sets the property Name. <para> The name of the container that receives the override. </para> </summary> </member> <member name="T:Amazon.ECS.Model.CreateClusterRequest"> <summary> Container for the parameters to the CreateCluster operation. Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action. </summary> </member> <member name="P:Amazon.ECS.Model.CreateClusterRequest.ClusterName"> <summary> Gets and sets the property ClusterName. <para> The name of your cluster. If you do not specify a name for your cluster, you create a cluster named <code>default</code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. </para> </summary> </member> <member name="T:Amazon.ECS.Model.CreateClusterResponse"> <summary> Configuration for accessing Amazon CreateCluster service </summary> </member> <member name="T:Amazon.ECS.Model.CreateClusterResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.CreateClusterResult.Cluster"> <summary> Gets and sets the property Cluster. <para> The full description of your new cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateClusterResponse.CreateClusterResult"> <summary> Gets and sets the CreateClusterResult property. Represents the output of a CreateCluster operation. </summary> </member> <member name="T:Amazon.ECS.Model.CreateServiceRequest"> <summary> Container for the parameters to the CreateService operation. Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>. <para> You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an <a>UpdateService</a> operation), the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. </para> <para> If the <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore the <code>desiredCount</code> temporarily during a deployment. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>minimumHealthyPercent</code> of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state; tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs. </para> <para> The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks, a <code>maximumPercent</code> value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%. </para> <para> When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic: </para> <ul> <li> <para> Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes). </para> </li> <li> <para> Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement. </para> </li> <li> <para> Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service. </para> </li> </ul> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.ClientToken"> <summary> Gets and sets the property ClientToken. <para> Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.DeploymentConfiguration"> <summary> Gets and sets the property DeploymentConfiguration. <para> Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.DesiredCount"> <summary> Gets and sets the property DesiredCount. <para> The number of instantiations of the specified task definition to place and keep running on your cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.LoadBalancers"> <summary> Gets and sets the property LoadBalancers. <para> A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.Role"> <summary> Gets and sets the property Role. <para> The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.ServiceName"> <summary> Gets and sets the property ServiceName. <para> The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceRequest.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used. </para> </summary> </member> <member name="T:Amazon.ECS.Model.CreateServiceResponse"> <summary> Configuration for accessing Amazon CreateService service </summary> </member> <member name="T:Amazon.ECS.Model.CreateServiceResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceResult.Service"> <summary> Gets and sets the property Service. <para> The full description of your service following the create call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.CreateServiceResponse.CreateServiceResult"> <summary> Gets and sets the CreateServiceResult property. Represents the output of a CreateService operation. </summary> </member> <member name="T:Amazon.ECS.Model.DeleteClusterRequest"> <summary> Container for the parameters to the DeleteCluster operation. Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>. </summary> </member> <member name="P:Amazon.ECS.Model.DeleteClusterRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster to delete. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeleteClusterResponse"> <summary> Configuration for accessing Amazon DeleteCluster service </summary> </member> <member name="T:Amazon.ECS.Model.DeleteClusterResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteClusterResult.Cluster"> <summary> Gets and sets the property Cluster. <para> The full description of the deleted cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteClusterResponse.DeleteClusterResult"> <summary> Gets and sets the DeleteClusterResult property. Represents the output of a DeleteCluster operation. </summary> </member> <member name="T:Amazon.ECS.Model.DeleteServiceRequest"> <summary> Container for the parameters to the DeleteService operation. Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>. <note> <para> When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations; however, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services will return a <code>ServiceNotFoundException</code> error. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteServiceRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteServiceRequest.Service"> <summary> Gets and sets the property Service. <para> The name of the service to delete. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeleteServiceResponse"> <summary> Configuration for accessing Amazon DeleteService service </summary> </member> <member name="T:Amazon.ECS.Model.DeleteServiceResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteServiceResult.Service"> <summary> Gets and sets the property Service. <para> The full description of the deleted service. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeleteServiceResponse.DeleteServiceResult"> <summary> Gets and sets the DeleteServiceResult property. Represents the output of a DeleteService operation. </summary> </member> <member name="T:Amazon.ECS.Model.Deployment"> <summary> The details of an Amazon ECS service deployment. </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.CreatedAt"> <summary> Gets and sets the property CreatedAt. <para> The Unix time in seconds and milliseconds when the service was created. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.DesiredCount"> <summary> Gets and sets the property DesiredCount. <para> The most recent desired count of tasks that was specified for the service to deploy or maintain. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.Id"> <summary> Gets and sets the property Id. <para> The ID of the deployment. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.PendingCount"> <summary> Gets and sets the property PendingCount. <para> The number of tasks in the deployment that are in the <code>PENDING</code> status. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.RunningCount"> <summary> Gets and sets the property RunningCount. <para> The number of tasks in the deployment that are in the <code>RUNNING</code> status. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.Status"> <summary> Gets and sets the property Status. <para> The status of the deployment. Valid values are <code>PRIMARY</code> (for the most recent deployment), <code>ACTIVE</code> (for previous deployments that still have tasks running, but are being replaced with the <code>PRIMARY</code> deployment), and <code>INACTIVE</code> (for deployments that have been completely replaced). </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The most recent task definition that was specified for the service to use. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Deployment.UpdatedAt"> <summary> Gets and sets the property UpdatedAt. <para> The Unix time in seconds and milliseconds when the service was last updated. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeploymentConfiguration"> <summary> Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. </summary> </member> <member name="P:Amazon.ECS.Model.DeploymentConfiguration.MaximumPercent"> <summary> Gets and sets the property MaximumPercent. <para> The upper limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that can be running in a service during a deployment. The maximum number of tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>maximumPercent</code>/100, rounded down to the nearest integer value. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeploymentConfiguration.MinimumHealthyPercent"> <summary> Gets and sets the property MinimumHealthyPercent. <para> The lower limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that must remain running and healthy in a service during a deployment. The minimum healthy tasks during a deployment is the <code>desiredCount</code> multiplied by the <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterContainerInstanceRequest"> <summary> Container for the parameters to the DeregisterContainerInstance operation. Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks. <para> If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources. </para> <para> Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing. </para> <note> <para> When you terminate a container instance, it is automatically deregistered from your cluster. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterContainerInstanceRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterContainerInstanceRequest.ContainerInstance"> <summary> Gets and sets the property ContainerInstance. <para> The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterContainerInstanceRequest.Force"> <summary> Gets and sets the property Force. <para> Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running and they continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterContainerInstanceResponse"> <summary> Configuration for accessing Amazon DeregisterContainerInstance service </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterContainerInstanceResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterContainerInstanceResult.ContainerInstance"> <summary> Gets and sets the property ContainerInstance. </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterContainerInstanceResponse.DeregisterContainerInstanceResult"> <summary> Gets and sets the DeregisterContainerInstanceResult property. Represents the output of a DeregisterContainerInstance operation. </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterTaskDefinitionRequest"> <summary> Container for the parameters to the DeregisterTaskDefinition operation. Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as <code>INACTIVE</code>. Existing tasks and services that reference an <code>INACTIVE</code> task definition continue to run without disruption. Existing services that reference an <code>INACTIVE</code> task definition can still scale up or down by modifying the service's desired count. <para> You cannot use an <code>INACTIVE</code> task definition to run new tasks or create new services, and you cannot update an existing service to reference an <code>INACTIVE</code> task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect). </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterTaskDefinitionRequest.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a <code>revision</code>. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterTaskDefinitionResponse"> <summary> Configuration for accessing Amazon DeregisterTaskDefinition service </summary> </member> <member name="T:Amazon.ECS.Model.DeregisterTaskDefinitionResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterTaskDefinitionResult.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The full description of the deregistered task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DeregisterTaskDefinitionResponse.DeregisterTaskDefinitionResult"> <summary> Gets and sets the DeregisterTaskDefinitionResult property. Represents the output of a DeregisterTaskDefinition operation. </summary> </member> <member name="T:Amazon.ECS.Model.DescribeClustersRequest"> <summary> Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters. </summary> </member> <member name="P:Amazon.ECS.Model.DescribeClustersRequest.Clusters"> <summary> Gets and sets the property Clusters. <para> A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DescribeClustersResponse"> <summary> Configuration for accessing Amazon DescribeClusters service </summary> </member> <member name="T:Amazon.ECS.Model.DescribeClustersResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeClustersResult.Clusters"> <summary> Gets and sets the property Clusters. <para> The list of clusters. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeClustersResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeClustersResponse.DescribeClustersResult"> <summary> Gets and sets the DescribeClustersResult property. Represents the output of a DescribeClusters operation. </summary> </member> <member name="T:Amazon.ECS.Model.DescribeContainerInstancesRequest"> <summary> Container for the parameters to the DescribeContainerInstances operation. Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested. </summary> </member> <member name="P:Amazon.ECS.Model.DescribeContainerInstancesRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeContainerInstancesRequest.ContainerInstances"> <summary> Gets and sets the property ContainerInstances. <para> A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DescribeContainerInstancesResponse"> <summary> Configuration for accessing Amazon DescribeContainerInstances service </summary> </member> <member name="T:Amazon.ECS.Model.DescribeContainerInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeContainerInstancesResult.ContainerInstances"> <summary> Gets and sets the property ContainerInstances. <para> The list of container instances. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeContainerInstancesResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeContainerInstancesResponse.DescribeContainerInstancesResult"> <summary> Gets and sets the DescribeContainerInstancesResult property. Represents the output of a DescribeContainerInstances operation. </summary> </member> <member name="T:Amazon.ECS.Model.DescribeServicesRequest"> <summary> Container for the parameters to the DescribeServices operation. Describes the specified services running in your cluster. </summary> </member> <member name="P:Amazon.ECS.Model.DescribeServicesRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeServicesRequest.Services"> <summary> Gets and sets the property Services. <para> A list of services to describe. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DescribeServicesResponse"> <summary> Configuration for accessing Amazon DescribeServices service </summary> </member> <member name="T:Amazon.ECS.Model.DescribeServicesResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeServicesResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeServicesResult.Services"> <summary> Gets and sets the property Services. <para> The list of services described. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeServicesResponse.DescribeServicesResult"> <summary> Gets and sets the DescribeServicesResult property. Represents the output of a DescribeServices operation. </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTaskDefinitionRequest"> <summary> Container for the parameters to the DescribeTaskDefinition operation. Describes a task definition. You can specify a <code>family</code> and <code>revision</code> to find information about a specific task definition, or you can simply specify the family to find the latest <code>ACTIVE</code> revision in that family. <note> <para> You can only describe <code>INACTIVE</code> task definitions while an active task or service references them. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTaskDefinitionRequest.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The <code>family</code> for the latest <code>ACTIVE</code> revision, <code>family</code> and <code>revision</code> (<code>family:revision</code>) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTaskDefinitionResponse"> <summary> Configuration for accessing Amazon DescribeTaskDefinition service </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTaskDefinitionResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTaskDefinitionResult.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The full task definition description. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTaskDefinitionResponse.DescribeTaskDefinitionResult"> <summary> Gets and sets the DescribeTaskDefinitionResult property. Represents the output of a DescribeTaskDefinition operation. </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTasksRequest"> <summary> Container for the parameters to the DescribeTasks operation. Describes a specified task or tasks. </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTasksRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTasksRequest.Tasks"> <summary> Gets and sets the property Tasks. <para> A space-separated list of task IDs or full Amazon Resource Name (ARN) entries. </para> </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTasksResponse"> <summary> Configuration for accessing Amazon DescribeTasks service </summary> </member> <member name="T:Amazon.ECS.Model.DescribeTasksResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTasksResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTasksResult.Tasks"> <summary> Gets and sets the property Tasks. <para> The list of tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.DescribeTasksResponse.DescribeTasksResult"> <summary> Gets and sets the DescribeTasksResult property. Represents the output of a DescribeTasks operation. </summary> </member> <member name="T:Amazon.ECS.Model.Failure"> <summary> A failed resource. </summary> </member> <member name="P:Amazon.ECS.Model.Failure.Arn"> <summary> Gets and sets the property Arn. <para> The Amazon Resource Name (ARN) of the failed resource. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Failure.Reason"> <summary> Gets and sets the property Reason. <para> The reason for the failure. </para> </summary> </member> <member name="T:Amazon.ECS.Model.HostEntry"> <summary> Hostnames and IP address entries that are added to the <code>/etc/hosts</code> file of a container via the <code>extraHosts</code> parameter of its <a>ContainerDefinition</a>. </summary> </member> <member name="P:Amazon.ECS.Model.HostEntry.Hostname"> <summary> Gets and sets the property Hostname. <para> The hostname to use in the <code>/etc/hosts</code> entry. </para> </summary> </member> <member name="P:Amazon.ECS.Model.HostEntry.IpAddress"> <summary> Gets and sets the property IpAddress. <para> The IP address to use in the <code>/etc/hosts</code> entry. </para> </summary> </member> <member name="T:Amazon.ECS.Model.HostVolumeProperties"> <summary> Details on a container instance host volume. </summary> </member> <member name="P:Amazon.ECS.Model.HostVolumeProperties.SourcePath"> <summary> Gets and sets the property SourcePath. <para> The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. </para> </summary> </member> <member name="T:Amazon.ECS.Model.InvalidParameterException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.InvalidParameterException.#ctor(System.String)"> <summary> Constructs a new InvalidParameterException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.KeyValuePair"> <summary> A key and value pair object. </summary> </member> <member name="P:Amazon.ECS.Model.KeyValuePair.Name"> <summary> Gets and sets the property Name. <para> The name of the key value pair. For environment variables, this is the name of the environment variable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.KeyValuePair.Value"> <summary> Gets and sets the property Value. <para> The value of the key value pair. For environment variables, this is the value of the environment variable. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListClustersRequest"> <summary> Container for the parameters to the ListClusters operation. Returns a list of existing clusters. </summary> </member> <member name="P:Amazon.ECS.Model.ListClustersRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of cluster results returned by <code>ListClusters</code> in paginated output. When this parameter is used, <code>ListClusters</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListClusters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListClusters</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListClustersRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListClusters</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListClustersResponse"> <summary> Configuration for accessing Amazon ListClusters service </summary> </member> <member name="T:Amazon.ECS.Model.ListClustersResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListClustersResult.ClusterArns"> <summary> Gets and sets the property ClusterArns. <para> The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListClustersResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListClusters</code> request. When the results of a <code>ListClusters</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListClustersResponse.ListClustersResult"> <summary> Gets and sets the ListClustersResult property. Represents the output of a ListClusters operation. </summary> </member> <member name="T:Amazon.ECS.Model.ListContainerInstancesRequest"> <summary> Container for the parameters to the ListContainerInstances operation. Returns a list of container instances in a specified cluster. </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of container instance results returned by <code>ListContainerInstances</code> in paginated output. When this parameter is used, <code>ListContainerInstances</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListContainerInstances</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListContainerInstances</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListContainerInstances</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListContainerInstancesResponse"> <summary> Configuration for accessing Amazon ListContainerInstances service </summary> </member> <member name="T:Amazon.ECS.Model.ListContainerInstancesResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesResult.ContainerInstanceArns"> <summary> Gets and sets the property ContainerInstanceArns. <para> The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListContainerInstances</code> request. When the results of a <code>ListContainerInstances</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListContainerInstancesResponse.ListContainerInstancesResult"> <summary> Gets and sets the ListContainerInstancesResult property. Represents the output of a ListContainerInstances operation. </summary> </member> <member name="T:Amazon.ECS.Model.ListServicesRequest"> <summary> Container for the parameters to the ListServices operation. Lists the services that are running in a specified cluster. </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of container instance results returned by <code>ListServices</code> in paginated output. When this parameter is used, <code>ListServices</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter is not used, then <code>ListServices</code> returns up to 10 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListServices</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListServicesResponse"> <summary> Configuration for accessing Amazon ListServices service </summary> </member> <member name="T:Amazon.ECS.Model.ListServicesResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListServices</code> request. When the results of a <code>ListServices</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesResult.ServiceArns"> <summary> Gets and sets the property ServiceArns. <para> The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListServicesResponse.ListServicesResult"> <summary> Gets and sets the ListServicesResult property. Represents the output of a ListServices operation. </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest"> <summary> Container for the parameters to the ListTaskDefinitionFamilies operation. Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any <code>ACTIVE</code> task definitions). You can filter the results with the <code>familyPrefix</code> parameter. </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest.FamilyPrefix"> <summary> Gets and sets the property FamilyPrefix. <para> The <code>familyPrefix</code> is a string that is used to filter the results of <code>ListTaskDefinitionFamilies</code>. If you specify a <code>familyPrefix</code>, only task definition family names that begin with the <code>familyPrefix</code> string are returned. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of task definition family results returned by <code>ListTaskDefinitionFamilies</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitionFamilies</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitionFamilies</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitionFamilies</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionFamiliesResponse"> <summary> Configuration for accessing Amazon ListTaskDefinitionFamilies service </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionFamiliesResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesResult.Families"> <summary> Gets and sets the property Families. <para> The list of task definition family names that match the <code>ListTaskDefinitionFamilies</code> request. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListTaskDefinitionFamilies</code> request. When the results of a <code>ListTaskDefinitionFamilies</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionFamiliesResponse.ListTaskDefinitionFamiliesResult"> <summary> Gets and sets the ListTaskDefinitionFamiliesResult property. Represents the output of a ListTaskDefinitionFamilies operation. </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionsRequest"> <summary> Container for the parameters to the ListTaskDefinitions operation. Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter. </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsRequest.FamilyPrefix"> <summary> Gets and sets the property FamilyPrefix. <para> The full family name with which to filter the <code>ListTaskDefinitions</code> results. Specifying a <code>familyPrefix</code> limits the listed task definitions to task definition revisions that belong to that family. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of task definition results returned by <code>ListTaskDefinitions</code> in paginated output. When this parameter is used, <code>ListTaskDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTaskDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTaskDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListTaskDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsRequest.Sort"> <summary> Gets and sets the property Sort. <para> The order in which to sort the results. Valid values are <code>ASC</code> and <code>DESC</code>. By default (<code>ASC</code>), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to <code>DESC</code> reverses the sort order on family name and revision so that the newest task definitions in a family are listed first. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsRequest.Status"> <summary> Gets and sets the property Status. <para> The task definition status with which to filter the <code>ListTaskDefinitions</code> results. By default, only <code>ACTIVE</code> task definitions are listed. By setting this parameter to <code>INACTIVE</code>, you can view task definitions that are <code>INACTIVE</code> as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the <code>status</code> value constant in each subsequent request. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionsResponse"> <summary> Configuration for accessing Amazon ListTaskDefinitions service </summary> </member> <member name="T:Amazon.ECS.Model.ListTaskDefinitionsResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListTaskDefinitions</code> request. When the results of a <code>ListTaskDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsResult.TaskDefinitionArns"> <summary> Gets and sets the property TaskDefinitionArns. <para> The list of task definition Amazon Resource Name (ARN) entries for the <code>ListTaskDefinitions</code> request. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTaskDefinitionsResponse.ListTaskDefinitionsResult"> <summary> Gets and sets the ListTaskDefinitionsResult property. Represents the output of a ListTaskDefinitions operation. </summary> </member> <member name="T:Amazon.ECS.Model.ListTasksRequest"> <summary> Container for the parameters to the ListTasks operation. Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the <code>family</code>, <code>containerInstance</code>, and <code>desiredStatus</code> parameters. </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.ContainerInstance"> <summary> Gets and sets the property ContainerInstance. <para> The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the <code>ListTasks</code> results. Specifying a <code>containerInstance</code> limits the results to tasks that belong to that container instance. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.DesiredStatus"> <summary> Gets and sets the property DesiredStatus. <para> The task status with which to filter the <code>ListTasks</code> results. Specifying a <code>desiredStatus</code> of <code>STOPPED</code> limits the results to tasks that are in the <code>STOPPED</code> status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is <code>RUNNING</code>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.Family"> <summary> Gets and sets the property Family. <para> The name of the family with which to filter the <code>ListTasks</code> results. Specifying a <code>family</code> limits the results to tasks that belong to that family. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.MaxResults"> <summary> Gets and sets the property MaxResults. <para> The maximum number of task results returned by <code>ListTasks</code> in paginated output. When this parameter is used, <code>ListTasks</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListTasks</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListTasks</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value returned from a previous paginated <code>ListTasks</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.ServiceName"> <summary> Gets and sets the property ServiceName. <para> The name of the service with which to filter the <code>ListTasks</code> results. Specifying a <code>serviceName</code> limits the results to tasks that belong to that service. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksRequest.StartedBy"> <summary> Gets and sets the property StartedBy. <para> The <code>startedBy</code> value with which to filter the task results. Specifying a <code>startedBy</code> value limits the results to tasks that were started with that value. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ListTasksResponse"> <summary> Configuration for accessing Amazon ListTasks service </summary> </member> <member name="T:Amazon.ECS.Model.ListTasksResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksResult.NextToken"> <summary> Gets and sets the property NextToken. <para> The <code>nextToken</code> value to include in a future <code>ListTasks</code> request. When the results of a <code>ListTasks</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksResult.TaskArns"> <summary> Gets and sets the property TaskArns. <para> The list of task Amazon Resource Name (ARN) entries for the <code>ListTasks</code> request. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ListTasksResponse.ListTasksResult"> <summary> Gets and sets the ListTasksResult property. Represents the output of a ListTasks operation. </summary> </member> <member name="T:Amazon.ECS.Model.LoadBalancer"> <summary> Details on a load balancer that is used with a service. </summary> </member> <member name="P:Amazon.ECS.Model.LoadBalancer.ContainerName"> <summary> Gets and sets the property ContainerName. <para> The name of the container (as it appears in a container definition) to associate with the load balancer. </para> </summary> </member> <member name="P:Amazon.ECS.Model.LoadBalancer.ContainerPort"> <summary> Gets and sets the property ContainerPort. <para> The port on the container to associate with the load balancer. This port must correspond to a <code>containerPort</code> in the service's task definition. Your container instances must allow ingress traffic on the <code>hostPort</code> of the port mapping. </para> </summary> </member> <member name="P:Amazon.ECS.Model.LoadBalancer.LoadBalancerName"> <summary> Gets and sets the property LoadBalancerName. <para> The name of the load balancer. </para> </summary> </member> <member name="T:Amazon.ECS.Model.LogConfiguration"> <summary> Log configuration options to send to a custom log driver for the container. </summary> </member> <member name="P:Amazon.ECS.Model.LogConfiguration.LogDriver"> <summary> Gets and sets the property LogDriver. <para> The log driver to use for the container. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep "Server API version"</code> </para> </summary> </member> <member name="P:Amazon.ECS.Model.LogConfiguration.Options"> <summary> Gets and sets the property Options. <para> The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep "Server API version"</code> </para> </summary> </member> <member name="T:Amazon.ECS.Model.MissingVersionException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.MissingVersionException.#ctor(System.String)"> <summary> Constructs a new MissingVersionException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.MountPoint"> <summary> Details on a volume mount point that is used in a container definition. </summary> </member> <member name="P:Amazon.ECS.Model.MountPoint.ContainerPath"> <summary> Gets and sets the property ContainerPath. <para> The path on the container to mount the host volume at. </para> </summary> </member> <member name="P:Amazon.ECS.Model.MountPoint.ReadOnly"> <summary> Gets and sets the property ReadOnly. <para> If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.MountPoint.SourceVolume"> <summary> Gets and sets the property SourceVolume. <para> The name of the volume to mount. </para> </summary> </member> <member name="T:Amazon.ECS.Model.NetworkBinding"> <summary> Details on the network bindings between a container and its host container instance. After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses. </summary> </member> <member name="P:Amazon.ECS.Model.NetworkBinding.BindIP"> <summary> Gets and sets the property BindIP. <para> The IP address that the container is bound to on the container instance. </para> </summary> </member> <member name="P:Amazon.ECS.Model.NetworkBinding.ContainerPort"> <summary> Gets and sets the property ContainerPort. <para> The port number on the container that is be used with the network binding. </para> </summary> </member> <member name="P:Amazon.ECS.Model.NetworkBinding.HostPort"> <summary> Gets and sets the property HostPort. <para> The port number on the host that is used with the network binding. </para> </summary> </member> <member name="P:Amazon.ECS.Model.NetworkBinding.Protocol"> <summary> Gets and sets the property Protocol. <para> The protocol used for the network binding. </para> </summary> </member> <member name="T:Amazon.ECS.Model.NoUpdateAvailableException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.NoUpdateAvailableException.#ctor(System.String)"> <summary> Constructs a new NoUpdateAvailableException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.PortMapping"> <summary> Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses. </summary> </member> <member name="P:Amazon.ECS.Model.PortMapping.ContainerPort"> <summary> Gets and sets the property ContainerPort. <para> The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see <code>hostPort</code>). </para> </summary> </member> <member name="P:Amazon.ECS.Model.PortMapping.HostPort"> <summary> Gets and sets the property HostPort. <para> The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. </para> <para> The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. </para> <para> The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the <code>remainingResources</code> of <a>DescribeContainerInstances</a> output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit). </para> </summary> </member> <member name="P:Amazon.ECS.Model.PortMapping.Protocol"> <summary> Gets and sets the property Protocol. <para> The protocol used for the port mapping. Valid values are <code>tcp</code> and <code>udp</code>. The default is <code>tcp</code>. </para> </summary> </member> <member name="T:Amazon.ECS.Model.RegisterTaskDefinitionRequest"> <summary> Container for the parameters to the RegisterTaskDefinition operation. Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </summary> </member> <member name="P:Amazon.ECS.Model.RegisterTaskDefinitionRequest.ContainerDefinitions"> <summary> Gets and sets the property ContainerDefinitions. <para> A list of container definitions in JSON format that describe the different containers that make up your task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RegisterTaskDefinitionRequest.Family"> <summary> Gets and sets the property Family. <para> You must specify a <code>family</code> for a task definition, which allows you to track multiple versions of the same task definition. The <code>family</code> is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RegisterTaskDefinitionRequest.Volumes"> <summary> Gets and sets the property Volumes. <para> A list of volume definitions in JSON format that containers in your task may use. </para> </summary> </member> <member name="T:Amazon.ECS.Model.RegisterTaskDefinitionResponse"> <summary> Configuration for accessing Amazon RegisterTaskDefinition service </summary> </member> <member name="T:Amazon.ECS.Model.RegisterTaskDefinitionResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.RegisterTaskDefinitionResult.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The full description of the registered task definition. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RegisterTaskDefinitionResponse.RegisterTaskDefinitionResult"> <summary> Gets and sets the RegisterTaskDefinitionResult property. Represents the output of a RegisterTaskDefinition operation. </summary> </member> <member name="T:Amazon.ECS.Model.Resource"> <summary> Describes the resources available for a container instance. </summary> </member> <member name="P:Amazon.ECS.Model.Resource.DoubleValue"> <summary> Gets and sets the property DoubleValue. <para> When the <code>doubleValue</code> type is set, the value of the resource must be a double precision floating-point type. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Resource.IntegerValue"> <summary> Gets and sets the property IntegerValue. <para> When the <code>integerValue</code> type is set, the value of the resource must be an integer. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Resource.LongValue"> <summary> Gets and sets the property LongValue. <para> When the <code>longValue</code> type is set, the value of the resource must be an extended precision floating-point type. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Resource.Name"> <summary> Gets and sets the property Name. <para> The name of the resource, such as <code>CPU</code>, <code>MEMORY</code>, <code>PORTS</code>, or a user-defined resource. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Resource.StringSetValue"> <summary> Gets and sets the property StringSetValue. <para> When the <code>stringSetValue</code> type is set, the value of the resource must be a string type. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Resource.Type"> <summary> Gets and sets the property Type. <para> The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>, <code>LONG</code>, or <code>STRINGSET</code>. </para> </summary> </member> <member name="T:Amazon.ECS.Model.RunTaskRequest"> <summary> Container for the parameters to the RunTask operation. Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use <code>StartTask</code> instead. <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskRequest.Count"> <summary> Gets and sets the property Count. <para> The number of instantiations of the specified task to place on your cluster. </para> <important> <para> The <code>count</code> parameter is limited to 10 tasks per call. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskRequest.Overrides"> <summary> Gets and sets the property Overrides. <para> A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override. </para> <note> <para> A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskRequest.StartedBy"> <summary> Gets and sets the property StartedBy. <para> An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. </para> <para> If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskRequest.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to run. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used. </para> </summary> </member> <member name="T:Amazon.ECS.Model.RunTaskResponse"> <summary> Configuration for accessing Amazon RunTask service </summary> </member> <member name="T:Amazon.ECS.Model.RunTaskResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskResult.Tasks"> <summary> Gets and sets the property Tasks. <para> A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here. </para> </summary> </member> <member name="P:Amazon.ECS.Model.RunTaskResponse.RunTaskResult"> <summary> Gets and sets the RunTaskResult property. Represents the output of a RunTask operation. </summary> </member> <member name="T:Amazon.ECS.Model.ServerException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ServerException.#ctor(System.String)"> <summary> Constructs a new ServerException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.Service"> <summary> Details on a service within a cluster </summary> </member> <member name="P:Amazon.ECS.Model.Service.ClusterArn"> <summary> Gets and sets the property ClusterArn. <para> The Amazon Resource Name (ARN) of the of the cluster that hosts the service. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.DeploymentConfiguration"> <summary> Gets and sets the property DeploymentConfiguration. <para> Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.Deployments"> <summary> Gets and sets the property Deployments. <para> The current state of deployments for the service. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.DesiredCount"> <summary> Gets and sets the property DesiredCount. <para> The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with <a>CreateService</a>, and it can be modified with <a>UpdateService</a>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.Events"> <summary> Gets and sets the property Events. <para> The event stream for your service. A maximum of 100 of the latest events are displayed. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.LoadBalancers"> <summary> Gets and sets the property LoadBalancers. <para> A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.PendingCount"> <summary> Gets and sets the property PendingCount. <para> The number of tasks in the cluster that are in the <code>PENDING</code> state. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.RunningCount"> <summary> Gets and sets the property RunningCount. <para> The number of tasks in the cluster that are in the <code>RUNNING</code> state. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.ServiceArn"> <summary> Gets and sets the property ServiceArn. <para> The Amazon Resource Name (ARN) that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the service, the AWS account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, arn:aws:ecs:<i>region</i>:<i>012345678910</i>:service/<i>my-service</i>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.ServiceName"> <summary> Gets and sets the property ServiceName. <para> The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.Status"> <summary> Gets and sets the property Status. <para> The status of the service. The valid values are <code>ACTIVE</code>, <code>DRAINING</code>, or <code>INACTIVE</code>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Service.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The task definition to use for tasks in the service. This value is specified when the service is created with <a>CreateService</a>, and it can be modified with <a>UpdateService</a>. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ServiceEvent"> <summary> Details on an event associated with a service. </summary> </member> <member name="P:Amazon.ECS.Model.ServiceEvent.CreatedAt"> <summary> Gets and sets the property CreatedAt. <para> The Unix time in seconds and milliseconds when the event was triggered. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ServiceEvent.Id"> <summary> Gets and sets the property Id. <para> The ID string of the event. </para> </summary> </member> <member name="P:Amazon.ECS.Model.ServiceEvent.Message"> <summary> Gets and sets the property Message. <para> The event message. </para> </summary> </member> <member name="T:Amazon.ECS.Model.ServiceNotActiveException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ServiceNotActiveException.#ctor(System.String)"> <summary> Constructs a new ServiceNotActiveException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.ServiceNotFoundException"> <summary> ECS exception </summary> </member> <member name="M:Amazon.ECS.Model.ServiceNotFoundException.#ctor(System.String)"> <summary> Constructs a new ServiceNotFoundException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="T:Amazon.ECS.Model.StartTaskRequest"> <summary> Container for the parameters to the StartTask operation. Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use <code>RunTask</code> instead. <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskRequest.ContainerInstances"> <summary> Gets and sets the property ContainerInstances. <para> The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. </para> <important> <para> The list of container instances to start tasks on is limited to 10. </para> </important> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskRequest.Overrides"> <summary> Gets and sets the property Overrides. <para> A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override. </para> <note> <para> A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure. </para> </note> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskRequest.StartedBy"> <summary> Gets and sets the property StartedBy. <para> An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. </para> <para> If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskRequest.TaskDefinition"> <summary> Gets and sets the property TaskDefinition. <para> The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full Amazon Resource Name (ARN) of the task definition to start. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used. </para> </summary> </member> <member name="T:Amazon.ECS.Model.StartTaskResponse"> <summary> Configuration for accessing Amazon StartTask service </summary> </member> <member name="T:Amazon.ECS.Model.StartTaskResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskResult.Failures"> <summary> Gets and sets the property Failures. <para> Any failures associated with the call. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskResult.Tasks"> <summary> Gets and sets the property Tasks. <para> A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StartTaskResponse.StartTaskResult"> <summary> Gets and sets the StartTaskResult property. Represents the output of a StartTask operation. </summary> </member> <member name="T:Amazon.ECS.Model.StopTaskRequest"> <summary> Container for the parameters to the StopTask operation. Stops a running task. <para> When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StopTaskRequest.Cluster"> <summary> Gets and sets the property Cluster. <para> The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StopTaskRequest.Reason"> <summary> Gets and sets the property Reason. <para> An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent <a>DescribeTasks</a> API operations on this task. Up to 255 characters are allowed in this message. </para> </summary> </member> <member name="P:Amazon.ECS.Model.StopTaskRequest.Task"> <summary> Gets and sets the property Task. <para> The task ID or full Amazon Resource Name (ARN) entry of the task to stop. </para> </summary> </member> <member name="T:Amazon.ECS.Model.StopTaskResponse"> <summary> Configuration for accessing Amazon StopTask service </summary> </member> <member name="T:Amazon.ECS.Model.StopTaskResult"> <summary> </summary> </member> <member name="P:Amazon.ECS.Model.StopTaskResult.Task"> <summary> Gets and sets the property Task. </summary> </member> <member name="P:Amazon.ECS.Model.StopTaskResponse.StopTaskResult"> <summary> Gets and sets the StopTaskResult property. Represents the output of a StopTask operation. </summary> </member> <member name="T:Amazon.ECS.Model.Task"> <summary> Details on a task in a cluster. </summary> </member> <member name="P:Amazon.ECS.Model.Task.ClusterArn"> <summary> Gets and sets the property ClusterArn. <para> The Amazon Resource Name (ARN) of the of the cluster that hosts the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.ContainerInstanceArn"> <summary> Gets and sets the property ContainerInstanceArn. <para> The Amazon Resource Name (ARN) of the container instances that host the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.Containers"> <summary> Gets and sets the property Containers. <para> The containers associated with the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.CreatedAt"> <summary> Gets and sets the property CreatedAt. <para> The Unix time in seconds and milliseconds when the task was created (the task entered the <code>PENDING</code> state). </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.DesiredStatus"> <summary> Gets and sets the property DesiredStatus. <para> The desired status of the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.LastStatus"> <summary> Gets and sets the property LastStatus. <para> The last known status of the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.Overrides"> <summary> Gets and sets the property Overrides. <para> One or more container overrides. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.StartedAt"> <summary> Gets and sets the property StartedAt. <para> The Unix time in seconds and milliseconds when the task was started (the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state). </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.StartedBy"> <summary> Gets and sets the property StartedBy. <para> The tag specified when a task is started. If the task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.StoppedAt"> <summary> Gets and sets the property StoppedAt. <para> The Unix time in seconds and milliseconds when the task was stopped (the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state). </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.StoppedReason"> <summary> Gets and sets the property StoppedReason. <para> The reason the task was stopped. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.TaskArn"> <summary> Gets and sets the property TaskArn. <para> The Amazon Resource Name (ARN) of the task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.Task.TaskDefinitionArn"> <summary> Gets and sets the property TaskDefinitionArn. <para> The Amazon Resource Name (ARN) of the of the task definition that creates the task. </para> </summary> </member> <member name="T:Amazon.ECS.Model.TaskDefinition"> <summary> Details of a task definition. </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.ContainerDefinitions"> <summary> Gets and sets the property ContainerDefinitions. <para> A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see <a href="http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.Family"> <summary> Gets and sets the property Family. <para> The family of your task definition, used as the definition name. </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.RequiresAttributes"> <summary> Gets and sets the property RequiresAttributes. <para> The container instance attributes required by your task. </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.Revision"> <summary> Gets and sets the property Revision. <para> The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is <code>1</code>; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family). </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.Status"> <summary> Gets and sets the property Status. <para> The status of the task definition. </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.TaskDefinitionArn"> <summary> Gets and sets the property TaskDefinitionArn. <para> The full Amazon Resource Name (ARN) of the of the task definition. </para> </summary> </member> <member name="P:Amazon.ECS.Model.TaskDefinition.Volumes"> <summary>